Skip to main content
POST
Add a note to a brand report

Authorizations

Authorization
string
header
required

Provide your API key as a Bearer token: Authorization: Bearer YOUR_API_KEY.

Path Parameters

reportId
string
required

Brand report identifier.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Body

application/json
date
string
required

Day to mark, YYYY-MM-DD.

text
string
required

Note text, 1 to 1000 characters after trimming.

Required string length: 1 - 1000
type
enum<string>

Optional. Only note is accepted.

Available options:
note

Response

The created note.

id
string
required

Annotation identifier.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

brandReportId
string
required

Brand report the annotation belongs to.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

date
string
required

Marked calendar day, YYYY-MM-DD.

type
enum<string>
required

note for a free-text note; recommendation for a recommendation marked as done in the app. Only notes can be created or edited through the API.

Available options:
note,
recommendation
text
string
required

Annotation text.

createdBy
string
required

Opaque identifier of the user who created the annotation.

createdDate
string
required

Creation timestamp (ISO 8601).

updatedDate
string
required

Last update timestamp (ISO 8601).

recommendationId
string

Recommendation the annotation marks. Present only when type is recommendation.