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.

Tool name: list_organizations. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.

Example prompt#

text

List the workspaces I belong to.

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, _meta } with paginated results.

Get organization refresh status#

Retrieve whether activity or social-account enrichment is updating organization metrics in the background.

Tool name: get_organization_refresh_status. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.

Example prompt#

text

Show me the details for this organization refresh status.

Details to provide#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier whose background refresh status should be checked.

What you'll get back#

Returns { data, _meta } with the result.

Get organization#

Retrieve a single organization by ID.

Tool name: get_organization. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.

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, _meta } with the result.

Create organization#

Create an organization with a name, timezone, and currency, then assign the requesting user as owner.

Tool name: create_organization. Protocol hints: readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=false.

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, _meta } with the result.

Update organization#

Update an organization's name, avatar, timezone, currency, or country.

Tool name: update_organization. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.

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).
avatarKey	`string \| null`	—	Storage key for the organization avatar image. Set to null to remove.
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.

What you'll get back#

Returns { data, _meta } with the result.

Delete organization#

Permanently delete an organization and all associated data.

Tool name: delete_organization. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.

Owner only

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, _meta } with the result.

This changes data

Deleting an organization permanently removes all activities, campaigns, creators, costs, analytics, and team members. This action cannot be undone.

List organization users#

List users in an organization with pagination and search.

Tool name: list_organization_users. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.

Example prompt#

text

Who is on my team?

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, _meta } with paginated results.

Add organization user#

Add an existing user to an organization with a specified role.

Tool name: add_organization_user. Protocol hints: readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=false.

Owner only

Example prompt#

text

Add this user to my workspace.

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, _meta } with the result.

Update organization user role#

Update a user's role within an organization.

Tool name: update_organization_user_role. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.

Owner only

Example prompt#

text

Make this team member an owner.

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, _meta } with the result.

Remove organization user#

Remove a user's membership from an organization.

Tool name: remove_organization_user. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.

Owner only

Example prompt#

text

Remove this member from my workspace.

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, _meta } with the result.

Invite organization user#

Invite a user to an organization by email.

Tool name: invite_organization_user. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=false, openWorldHint=true.

Owner only

Example prompt#

text

Invite a user to my organization.

Details to provide#

Name	Type	Required	Description
email	`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, _meta } with the result.

Authorization required

Only organization owners can invite new members.