campaigns#
Browse campaigns resource actions that can be discovered, described, and executed through the Brandwave MCP server.
Capability flow
discover-brandwave-capabilities, describe-brandwave-action, and execute-brandwave-action to work with these actions.list-campaigns#
Retrieve a paginated list of campaigns for an organization.
Example prompt#
List all campaigns in my organization.Parameters#
| 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. |
Response#
Returns { items, totalCount, facets } with paginated results.
Underlying SDK method: bw.campaigns.list(params)
get-campaign-stats#
Aggregate statistics for campaigns matching the given filters.
Example prompt#
Show me the details for this campaign stats.Parameters#
| 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). |
Response#
Returns { data } with the result.
Underlying SDK method: bw.campaigns.stats(params)
get-campaign#
Retrieve a single campaign by ID with full details.
Example prompt#
Show me the details for this campaign.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Campaign identifier. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.campaigns({ id })
create-campaign#
Create a new campaign.
Example prompt#
Create a new campaign.Parameters#
| 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). |
Response#
Returns { data } with the result.
Underlying SDK method: bw.campaigns.create(params)
update-campaign#
Update a campaign's details, status, budget, or dates.
Example prompt#
Update the campaign.Parameters#
| 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). |
Response#
Returns { data } with the result.
Underlying SDK method: bw.campaigns.update(params)
delete-campaign#
Permanently delete a campaign and unlink all associated activities.
Example prompt#
Delete this campaign.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Campaign identifier to delete. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.campaigns.delete(params)
Destructive action
link-campaign-activity#
Link an activity to a campaign.
Example prompt#
Connect the campaign activity.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| campaignId | string (UUID) | Required | Campaign identifier to link the activity to. |
| activityId | string (UUID) | Required | Activity identifier to link. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.campaigns.activities.link(params)
unlink-campaign-activity#
Unlink an activity from a campaign.
Example prompt#
Remove the campaign activity.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| campaignActivityId | string (UUID) | Required | Campaign-activity association identifier to remove. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.campaigns.activities.unlink(params)