Users#

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

List users in an organization with pagination and name search.

Reads dataSafe to repeat

Example prompt#

text

List all 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.

Create user#

Create a new user record during sign-up.

Example prompt#

text

Create a new user.

Details to provide#

Name	Type	Required	Description
userId	`string (UUID)`	Required	User identifier (from auth provider).
email	`string`	Required	User email address.
name	`string \| null`	—	User display name (max 255 characters).
jobRole	`string \| null`	—	User job role (max 100 characters).

What you'll get back#

Returns { data } with the result.

Get user#

Retrieve a single user by ID.

Reads dataSafe to repeat

Example prompt#

text

Show me the details for this user.

Details to provide#

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

What you'll get back#

Returns { data } with the result.

Update user#

Update a user's profile information. Updatable fields: name (display name), email, jobRole (e.g. 'Head of Marketing'), avatarKey (storage key, null to remove). Only include the fields you want to change.

Example prompt#

text

Update the user.

Details to provide#

Name	Type	Required	Description
userId	`string (UUID)`	Required	User identifier to update.
name	`string`	—	Updated display name (1-255 characters).
email	`string`	—	Updated email address.
jobRole	`string \| null`	—	Updated job role (max 100 characters).
avatarKey	`string \| null`	—	Storage key for the user avatar image. Set to null to remove.

What you'll get back#

Returns { data } with the result.

Request avatar upload#

Request a presigned URL for uploading a user avatar image. The client uploads the file directly using the returned URL, then calls PATCH /users/:id with the avatarKey.

Example prompt#

text

Request avatar upload.

Details to provide#

Name	Type	Required	Description
userId	`string (UUID)`	Required	User identifier requesting an avatar upload URL.
contentLength	`integer`	Required	Size of the file in bytes.
contentType	`'image/jpeg' \| 'image/png' \| 'image/webp' \| 'image/gif'`	Required	MIME type of the file.

What you'll get back#

Returns { data } with the result.

Change email#

Request a change to the user's email address.

Example prompt#

text

Change email.

Details to provide#

Name	Type	Required	Description
userId	`string (UUID)`	Required	User identifier requesting the email change.
newEmail	`string`	Required	The new email address to change to.

What you'll get back#

Returns { data } with the result.

Request user deletion#

Request an account deletion confirmation email after verifying ownership safeguards.

Example prompt#

text

Request user deletion.

Details to provide#

Name	Type	Required	Description
id	`string (UUID)`	Required	User identifier requesting account deletion.

What you'll get back#

Returns { data } with the result.

Confirm user deletion#

Validate an account deletion token and re-check ownership safeguards before final deletion.

Example prompt#

text

Confirm user deletion.

Details to provide#

Name	Type	Required	Description
id	`string (UUID)`	Required	User identifier confirming account deletion.
token	`string (UUID)`	Required	Deletion confirmation token from the email link.

What you'll get back#

Returns { data } with the result.

Delete user#

Delete a user account using an optional email confirmation token, revoke access, remove memberships, and clear saved profile details.

Changes data

Example prompt#

text

Delete this user.

Details to provide#

Name	Type	Required	Description
id	`string (UUID)`	Required	User identifier to delete.
token	`string (UUID)`	—	Optional deletion confirmation token from the email link.

What you'll get back#

Returns { data } with the result.

Get user settings#

Retrieve a user's personal settings.

Reads dataSafe to repeat

Example prompt#

text

Show me the details for this user settings.

Details to provide#

Name	Type	Required	Description
userId	`string (UUID)`	Required	User identifier to fetch settings for.

What you'll get back#

Returns { data } with the result.

Update user settings#

Create or update a user's settings, including switching the active organization and managing UI preferences.

Example prompt#

text

Update the user settings.

Details to provide#

Name	Type	Required	Description
userId	`string (UUID)`	Required	User identifier to update settings for.
activeOrganizationId	`string (UUID)`	—	Organization to set as the active workspace.
preferences	`object`	—	User UI preferences (shallow-merged into existing).

What you'll get back#

Returns { data } with the result.