Notes#

Create, read, update, and delete notes attached to activities, campaigns, or creators.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/notes#

List notes for an entity, ordered by most recent first.

bash

GET /v1/notes?organization_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01&entity_type=activity&entity_id=7f2e9b34-5c81-4d6a-8e07-9a3b1c5d2f02
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
entityType	`'activity' \| 'campaign' \| 'creator'`	Required	Type of entity to list notes for.
entityId	`string (UUID)`	Required	Entity identifier to list notes for.

Response#

Returns { items, totalCount, facets } with paginated results.

Underlying SDK method: bw.notes.list(params)

Scoping required

You must pass entityType ('activity', 'campaign', or 'creator') and entityId to scope the list.

GET /v1/notes/:id#

Retrieve a single note by ID.

bash

GET /v1/notes/:id
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
id	`string (UUID)`	Required	Note identifier.

Response#

Returns { data } with the result.

Underlying SDK method: bw.notes({ id })

POST /v1/notes#

Create a new note attached to an entity.

bash

POST /v1/notes
Authorization: Bearer {token}
Content-Type: application/json

{
  "organization_id": "1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01",
  "entity_type": "activity",
  "entity_id": "7f2e9b34-5c81-4d6a-8e07-9a3b1c5d2f02",
  "content": "Note content here."
}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
entityType	`'activity' \| 'campaign' \| 'creator'`	Required	Type of entity to attach the note to.
entityId	`string (UUID)`	Required	Entity identifier to attach the note to.
content	`string`	Required	Note content (plain text or markdown).
createdBy	`string (UUID) \| null`	—	User identifier who created the note.
createdByName	`string`	—	Display name of the note creator (max 255 characters).

Response#

Returns { data } with the result.

Underlying SDK method: bw.notes.create(params)

PATCH /v1/notes/:id#

Update a note's content.

bash

PATCH /v1/notes/:id
Authorization: Bearer {token}
Content-Type: application/json

{
  "note_id": "5e1a8c92-7b34-4d0f-9c6a-2e8b4f7d0a05",
  "content": "Note content here."
}

Parameters#

Name	Type	Required	Description
noteId	`string (UUID)`	Required	Note identifier to update.
content	`string`	Required	Updated note content.

Response#

Returns { data } with the result.

Underlying SDK method: bw.notes.update(params)

DELETE /v1/notes/:id#

Delete a note and remove it from its parent entity.

bash

DELETE /v1/notes/:id
Authorization: Bearer {token}
Content-Type: application/json

{
  "note_id": "5e1a8c92-7b34-4d0f-9c6a-2e8b4f7d0a05"
}

Parameters#

Name	Type	Required	Description
noteId	`string (UUID)`	Required	Note identifier to delete.

Response#

Returns { data } with the result.

Underlying SDK method: bw.notes.delete(params)