conversion-sources#
Browse conversion sources 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-conversion-sources#
List conversion sources with pagination, search, and sorting.
Example prompt#
List all conversion sources 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. |
Response#
Returns { items, totalCount, facets } with paginated results.
Underlying SDK method: bw.conversionSources.list(params)
get-conversion-source#
Retrieve a single conversion source by ID.
Example prompt#
Show me the details for this conversion source.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Conversion source identifier. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.conversionSources({ id })
create-conversion-source#
Create a new conversion source with a marketing channel category for tracking attribution.
Example prompt#
Create a new conversion source.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| name | string | Required | Conversion source name. |
| type | 'hdyhau' | 'promo_code' | 'tracking_link' | Required | Attribution method type. |
| category | 'organic_social' | 'podcast' | 'events' | 'paid' | 'referral' | 'other' | Required | Marketing channel category. |
| channel | 'instagram' | 'youtube' | 'tiktok' | 'twitter' | 'linkedin' | 'reddit' | null | — | Social media platform for this conversion source. |
| creatorId | string (UUID) | — | Creator associated with this source. |
| campaignId | string (UUID) | — | Campaign associated with this source. |
| code | string | — | Promo code or tracking code (max 255 characters). |
| url | string (URL) | — | Tracking URL for link-based attribution (max 2,048 characters). |
Response#
Returns { data } with the result.
Underlying SDK method: bw.conversionSources.create(params)
update-conversion-source#
Update a conversion source attribution type, category, social media channel, creator or campaign association, promo code, or tracking URL.
Example prompt#
Update the conversion source.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Conversion source identifier to update. |
| name | string | — | Updated name (1-255 characters). |
| type | 'hdyhau' | 'promo_code' | 'tracking_link' | — | Updated attribution type. |
| category | 'organic_social' | 'podcast' | 'events' | 'paid' | 'referral' | 'other' | — | Updated category. |
| channel | 'instagram' | 'youtube' | 'tiktok' | 'twitter' | 'linkedin' | 'reddit' | null | — | Updated social media platform. |
| creatorId | string (UUID) | null | — | Updated creator association. |
| campaignId | string (UUID) | null | — | Updated campaign association. |
| code | string | null | — | Updated promo/tracking code (max 255 characters). |
| url | string (URL) | null | — | Updated tracking URL (max 2,048 characters). |
| isActive | boolean | — | Whether this source is active. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.conversionSources.update(params)
delete-conversion-source#
Permanently delete a conversion source and disassociate its conversions.
Example prompt#
Delete this conversion source.Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Conversion source identifier to delete. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.conversionSources.delete(params)
Cascading effect