Organizations#
See how an AI assistant can help with organizations 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 organizations#
List organizations the current user belongs to, with membership details.
Reads dataSafe to repeat
Example prompt#
text
List all organizations 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). |
| userId | string (UUID) | Required | User identifier to list organizations for. |
What you'll get back#
Returns { items, totalCount, facets } with paginated results.
Get organization#
Retrieve a single organization by ID.
Reads dataSafe to repeat
Example prompt#
text
Show me the details for this organization.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Organization identifier. |
What you'll get back#
Returns { data } with the result.
Create organization#
Create an organization with a name, timezone, and currency, then assign the requesting user as owner.
Example prompt#
text
Create a new organization.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| userId | string (UUID) | Required | User identifier of the organization owner. |
| name | string | Required | Organization name. |
| ianaTimezone | 'UTC' | 'America/New_York' | 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/Anchorage' | 'Pacific/Honolulu' | 'America/Toronto' | 'America/Vancouver' | 'Europe/London' | 'Europe/Paris' | 'Europe/Berlin' | 'Australia/Sydney' | 'Australia/Melbourne' | 'Pacific/Auckland' | 'Asia/Tokyo' | 'Asia/Singapore' | null | — | IANA timezone identifier. |
| currency | 'USD' | 'CAD' | 'GBP' | 'EUR' | 'AUD' | 'NZD' | 'JPY' | 'SGD' | — | ISO 4217 currency code. |
What you'll get back#
Returns { data } with the result.
Complete first-time signup#
Create a first-time workspace using the submitted organization name, timezone, and currency.
Example prompt#
text
Complete organic signup for my organization.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| userId | string (UUID) | Required | User identifier completing first-time organic onboarding. |
| name | string | Required | Name of the real organization to create for the user. |
| ianaTimezone | 'UTC' | 'America/New_York' | 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/Anchorage' | 'Pacific/Honolulu' | 'America/Toronto' | 'America/Vancouver' | 'Europe/London' | 'Europe/Paris' | 'Europe/Berlin' | 'Australia/Sydney' | 'Australia/Melbourne' | 'Pacific/Auckland' | 'Asia/Tokyo' | 'Asia/Singapore' | null | — | IANA timezone identifier. |
| currency | 'USD' | 'CAD' | 'GBP' | 'EUR' | 'AUD' | 'NZD' | 'JPY' | 'SGD' | — | ISO 4217 currency code. |
What you'll get back#
Returns { data } with the result.
Update organization#
Update an organization's name, description, timezone, currency, conversion value for ROI calculations, or attribution window.
Owner only
Example prompt#
text
Update the organization.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Organization identifier to update. |
| name | string | — | Updated organization name (1-255 characters). |
| ianaTimezone | 'UTC' | 'America/New_York' | 'America/Chicago' | 'America/Denver' | 'America/Los_Angeles' | 'America/Anchorage' | 'Pacific/Honolulu' | 'America/Toronto' | 'America/Vancouver' | 'Europe/London' | 'Europe/Paris' | 'Europe/Berlin' | 'Australia/Sydney' | 'Australia/Melbourne' | 'Pacific/Auckland' | 'Asia/Tokyo' | 'Asia/Singapore' | null | — | Updated IANA timezone. |
| currency | 'USD' | 'CAD' | 'GBP' | 'EUR' | 'AUD' | 'NZD' | 'JPY' | 'SGD' | — | Updated currency code. |
| conversionValue | number | — | Average customer value for ROI calculations (non-negative). |
| defaultAttributionWindowDays | integer | null | — | Number of days for the attribution window (must be greater than zero). |
What you'll get back#
Returns { data } with the result.
Delete organization#
Permanently delete an organization and all associated data.
Owner only
Changes data
Example prompt#
text
Delete this organization.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Organization identifier to delete. |
What you'll get back#
Returns { data } with the result.
This changes data
Deleting an organization permanently removes all activities, campaigns, creators, costs, conversions, and team members. This action cannot be undone.
List organization users#
List users in an organization with pagination and search.
Reads dataSafe to repeat
Example prompt#
text
List all organization users 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. |
What you'll get back#
Returns { items, totalCount, facets } with paginated results.
Add organization user#
Add an existing user to an organization with a specified role.
Owner only
Example prompt#
text
Add the organization user.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| userId | string (UUID) | Required | User identifier to add. |
| role | 'owner' | 'member' | 'viewer' | Required | Role to assign (owner, member, or viewer). |
What you'll get back#
Returns { data } with the result.
Update organization user role#
Update a user's role within an organization.
Owner only
Example prompt#
text
Update the organization user role.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| userId | string (UUID) | Required | User identifier whose role is being changed. |
| role | 'owner' | 'member' | 'viewer' | Required | New role to assign (owner, member, or viewer). |
What you'll get back#
Returns { data } with the result.
Remove organization user#
Remove a user's membership from an organization.
Owner only
Changes data
Example prompt#
text
Remove the organization user.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| userId | string (UUID) | Required | User identifier to remove. |
What you'll get back#
Returns { data } with the result.
Invite organization user#
Invite a user to an organization by email.
Owner only
Example prompt#
text
Invite a user to my organization.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
string | Required | Email address to send the invite to. | |
| organizationId | string (UUID) | Required | Organization identifier. |
| role | 'owner' | 'member' | 'viewer' | Required | Role to assign to the invited user (owner, member, or viewer). |
What you'll get back#
Returns { data } with the result.
Authorization required
Only organization owners can invite new members.
Accept organization invite#
Accept a pending organization invite.
Example prompt#
text
Accept organization invite for my account.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| userId | string (UUID) | Required | User identifier accepting the invite. |
What you'll get back#
Returns { data } with the result.
Decline organization invite#
Decline a pending organization invite.
Example prompt#
text
Decline organization invite for my account.Details to provide#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| userId | string (UUID) | Required | User identifier declining the invite. |
What you'll get back#
Returns { data } with the result.