Skip to content

Delete an annotation

DELETE
/timeline/annotations/{id}
curl --request DELETE \
--url https://example.com/api/v1/timeline/annotations/1

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

id
required
integer

Deleted

Media typeapplication/json
object
deleted
required
boolean
Examplegenerated
{
"deleted": true
}

Invalid id

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
"error": "example"
}

Authentication required

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
"error": "example"
}

Not the author

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
"error": "example"
}

Annotation not found

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
"error": "example"
}

Failed to delete annotation

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
"error": "example"
}