Campaigns#

See how an AI assistant can help with campaigns 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 campaigns#

Retrieve a paginated list of campaigns for an organization.

Reads dataSafe to repeat

Example prompt#

text

List all campaigns in my organization.

Details to provide#

Name	Type	Required	Description
pageIndex	`integer`	Required	Zero-based page index for pagination.
pageSize	`integer`	Required	Number of items per page (1-100).
organizationId	`string (UUID)`	Required	Organization identifier.
searchTerm	`string`	—	Free-text search term to filter results (max 200 characters).
sortBy	`string`	—	Column name to sort by.
sortDirection	`'asc' \| 'desc'`	—	Sort direction: ascending or descending.
status	`'active' \| 'scheduled' \| 'completed' \| 'draft'`	—	Filter by campaign status.
creatorId	`string (UUID)`	—	Filter by creator identifier.

What you'll get back#

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

Get campaign stats#

Aggregate statistics for campaigns matching the given filters.

Reads dataSafe to repeat

Example prompt#

text

Show me the details for this campaign stats.

Details to provide#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
status	`'active' \| 'scheduled' \| 'completed' \| 'draft'`	—	Filter by campaign status.
creatorId	`string (UUID)`	—	Filter by creator identifier.
searchTerm	`string`	—	Free-text search term to filter results (max 200 characters).

What you'll get back#

Returns { data } with the result.

Get campaign#

Retrieve a single campaign by ID with full details.

Reads dataSafe to repeat

Example prompt#

text

Show me the details for this campaign.

Details to provide#

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

What you'll get back#

Returns { data } with the result.

Create campaign#

Create a new campaign.

Example prompt#

text

Create a new campaign.

Details to provide#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
name	`string`	Required	Campaign name.
startAt	`string (ISO 8601) \| null`	—	Campaign start date.
endAt	`string (ISO 8601) \| null`	—	Campaign end date.
budget	`number \| null`	—	Total campaign budget (non-negative, max 1B).

What you'll get back#

Returns { data } with the result.

Update campaign#

Update a campaign's details, status, budget, or dates.

Example prompt#

text

Update the campaign.

Details to provide#

Name	Type	Required	Description
id	`string (UUID)`	Required	Campaign identifier to update.
name	`string`	—	Updated campaign name (1-255 characters).
startAt	`string (ISO 8601) \| null`	—	Updated start date.
endAt	`string (ISO 8601) \| null`	—	Updated end date.
budget	`number \| null`	—	Updated budget (non-negative, max 1B).

What you'll get back#

Returns { data } with the result.

Delete campaign#

Permanently delete a campaign and unlink all associated activities.

Changes data

Example prompt#

text

Delete this campaign.

Details to provide#

Name	Type	Required	Description
id	`string (UUID)`	Required	Campaign identifier to delete.

What you'll get back#

Returns { data } with the result.

This changes data

Deleting a campaign permanently removes the campaign and unlinks all associated activities. This action cannot be undone.

Link campaign activity#

Link an activity to a campaign.

Example prompt#

text

Connect the campaign activity.

Details to provide#

Name	Type	Required	Description
campaignId	`string (UUID)`	Required	Campaign identifier to link the activity to.
activityId	`string (UUID)`	Required	Activity identifier to link.

What you'll get back#

Returns { data } with the result.

Unlink campaign activity#

Unlink an activity from a campaign.

Changes data

Example prompt#

text

Remove the campaign activity.

Details to provide#

Name	Type	Required	Description
campaignActivityId	`string (UUID)`	Required	Campaign-activity association identifier to remove.

What you'll get back#

Returns { data } with the result.