Notes#

See how an AI assistant can help with notes in Brandwave, including example prompts and the details it may ask for.

Using your AI assistant

Connect to the Brandwave MCP server, then ask your AI assistant in natural language. It will choose the right Brandwave task and ask for any details it needs.

List notes#

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

Reads dataSafe to repeat

Example prompt#

text
List all notes in my organization.

Details to provide#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
entityType'activity' | 'campaign' | 'creator'RequiredType of entity to list notes for.
entityIdstring (UUID)RequiredEntity identifier to list notes for.

What you'll get back#

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

Scoping required

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

Get note#

Retrieve a single note by ID.

Reads dataSafe to repeat

Example prompt#

text
Show me the details for this note.

Details to provide#

NameTypeRequiredDescription
idstring (UUID)RequiredNote identifier.

What you'll get back#

Returns { data } with the result.

Create note#

Create a new note attached to an entity.

Example prompt#

text
Create a new note.

Details to provide#

NameTypeRequiredDescription
organizationIdstring (UUID)RequiredOrganization identifier.
entityType'activity' | 'campaign' | 'creator'RequiredType of entity to attach the note to.
entityIdstring (UUID)RequiredEntity identifier to attach the note to.
contentstringRequiredNote content (plain text or markdown).
createdBystring (UUID) | nullUser identifier who created the note.
createdByNamestringDisplay name of the note creator (max 255 characters).

What you'll get back#

Returns { data } with the result.

Update note#

Update a note's content.

Example prompt#

text
Update the note.

Details to provide#

NameTypeRequiredDescription
noteIdstring (UUID)RequiredNote identifier to update.
contentstringRequiredUpdated note content.

What you'll get back#

Returns { data } with the result.

Delete note#

Delete a note and remove it from its parent entity.

Changes data

Example prompt#

text
Delete this note.

Details to provide#

NameTypeRequiredDescription
noteIdstring (UUID)RequiredNote identifier to delete.

What you'll get back#

Returns { data } with the result.