Annotations

Delete a website annotation

DELETE/api/websites/{websiteId}/annotations/{annotationId}

Deletes the specified dated note from the website.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Name	Type	Description
websiteIdrequired	string	ID of the website.
annotationIdrequired	string	ID of the annotation.

200The operation completed successfully.

Name	Type	Description
okrequired	any	Whether the operation succeeded.

200 example

{
  "ok": {}
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

404Not found.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

404 example

{
  "error": {
    "code": "not-found",
    "message": "Not found.",
    "status": 404
  }
}

cURL

curl -X DELETE 'https://api.example.com/api/websites/{websiteId}/annotations/{annotationId}' \
  -H 'Authorization: Bearer <token>'