Annotations

Create a website annotation

POST/api/websites/{websiteId}/annotations

Adds a dated note to the website, optionally marking it as an all-day annotation.

Headers

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

Path parameters

Name	Type	Description
websiteIdrequired	string	ID of the website.

Request body

Name	Type	Description
allDay	boolean	Whether the annotation applies to the entire day.
daterequired	string
noterequired	string	Text of the annotation.

Example request

{
  "allDay": true,
  "date": "2024-01-15T09:30:00Z",
  "note": "string"
}

Responses

200The operation completed successfully.

Name	Type	Description
allDayrequired	boolean	Whether the annotation applies to the entire day.
createdAtrequired	string	Date and time the record was created.
daterequired	string
idrequired	string	Unique identifier of the resource.
noterequired	string	Text of the annotation.
updatedAtrequired	string	Date and time the record was last updated.
userIdrequired	string	ID of the associated user.
websiteIdrequired	string	ID of the website.

200 example

{
  "allDay": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "date": "2024-01-15T09:30:00Z",
  "id": "string",
  "note": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userId": "string",
  "websiteId": "string"
}

400Bad request.

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

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

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

401 example

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

Code samples

cURL

curl -X POST 'https://api.example.com/api/websites/{websiteId}/annotations' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "allDay": true,
  "date": "2024-01-15T09:30:00Z",
  "note": "string"
}'

PreviousList website annotations NextGet a website annotation