Skip to Content
Mux Docs: Home
Update Annotation
patch

Updates an existing annotation.

Request body params
note
string

The annotation note content

date
integer

Datetime when the annotation applies (Unix timestamp)

sub_property_id
string

Customer-defined sub-property identifier

Request path & query params
ANNOTATION_ID
string

The annotation ID

patch
200
/data/v1/annotations/{ANNOTATION_ID}
Request
(application/json)
{
  "note": "This is a note",
  "date": 1745438400,
  "sub_property_id": "123456"
}
Response
(application/json)
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "note": "This is a note",
    "date": "2025-04-23T20:00:00Z",
    "sub_property_id": "123456"
  },
  "total_row_count": 1,
  "timeframe": [
    1745434800,
    1745438400
  ]
}