Brand Notebook
Authorizations
X-API-KEYstringRequired
Path parameters
siteIdstring · uuidRequired
Site ID
Query parameters
limitintegerOptionalDefault:
50offsetintegerOptionalDefault:
0sourcestringOptional
Filter by source (api, manual, etc.)
Responses
200
List of notebook entries
application/json
idstring · uuidOptional
titlestringOptional
contentstringOptional
meeting_datestring · date · nullableOptional
sourcestringOptional
processing_statusstring · enumOptionalPossible values:
created_atstring · date-timeOptional
updated_atstring · date-time · nullableOptional
get
/v1/brands/{siteId}/notebook200
List of notebook entries
Authorizations
X-API-KEYstringRequired
Path parameters
siteIdstring · uuidRequired
Site ID
Body
titlestring · max: 500Required
contentstring · max: 100000Required
meeting_datestring · date · nullableOptional
Responses
201
Entry created
application/json
post
/v1/brands/{siteId}/notebook201
Entry created
Authorizations
X-API-KEYstringRequired
Path parameters
siteIdstring · uuidRequired
entryIdstring · uuidRequired
Responses
200
Notebook entry detail
application/json
idstring · uuidOptional
titlestringOptional
contentstringOptional
meeting_datestring · date · nullableOptional
sourcestringOptional
processing_statusstring · enumOptionalPossible values:
created_atstring · date-timeOptional
updated_atstring · date-time · nullableOptional
get
/v1/brands/{siteId}/notebook/{entryId}200
Notebook entry detail
Authorizations
X-API-KEYstringRequired
Path parameters
siteIdstring · uuidRequired
entryIdstring · uuidRequired
Body
titlestring · max: 500Optional
contentstring · max: 100000Optional
meeting_datestring · date · nullableOptional
Responses
200
Entry updated
application/json
idstring · uuidOptional
titlestringOptional
contentstringOptional
meeting_datestring · date · nullableOptional
sourcestringOptional
processing_statusstring · enumOptionalPossible values:
created_atstring · date-timeOptional
updated_atstring · date-time · nullableOptional
put
/v1/brands/{siteId}/notebook/{entryId}200
Entry updated
Last updated
Was this helpful?