Edit an annotation

PATCH

/timeline/annotations/{id}

curl --request PATCH \
  --url https://example.com/api/v1/timeline/annotations/1 \
  --header 'Content-Type: application/json' \
  --data '{ "body": "example" }'

• API v1

Author-gated (403 for non-authors unless in AUTH-bypass mode).

Parameters

Path Parameters

id

required

integer

Request Body^required

Media typeapplication/json

object

body

required

string

>= 1 characters <= 4000 characters

Example^generated

{
  "body": "example"
}

Responses

200

Updated annotation

Media typeapplication/json

A user note attached to a single timeline event.

object

id

required

integer

source

required

The event source a timeline event originates from.

string

Allowed values: sync canary snapshot rollback

eventId

required

integer

body

required

string

authorUserId

required

integer

nullable

authorName

required

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "source": "sync"
}

400

Invalid id or body

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

401

Authentication required

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

403

Not the author

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

404

Annotation not found

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

500

Failed to update annotation

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}