Organizations#
Manage organizations, team members, invitations, and organization-level settings.
Provider required
BrandwaveProvider ancestor in your component tree. See the React Hooks overview for setup instructions.useListOrganizations#
List organizations the current user belongs to, with membership details.
import { useListOrganizations } from '@brandwave/react';
const { data, isLoading } = useListOrganizations({
pageIndex: 0,
pageSize: 25,
userId: 'user_abc123',
});Parameters#
| 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. |
Response#
Returns { items, totalCount, facets } with paginated results.
Underlying SDK method: bw.organizations.list(params)
useGetOrganization#
Retrieve a single organization by ID.
import { useGetOrganization } from '@brandwave/react';
const { data, isLoading } = useGetOrganization({
id: 'abc-123',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Organization identifier. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.get({ id })
useCreateOrganization#
Create an organization with a name, timezone, and currency, then assign the requesting user as owner.
import { useCreateOrganization } from '@brandwave/react';
const { mutate, isPending } = useCreateOrganization();
mutate({
userId: 'user_abc123',
name: 'My Campaign',
});Parameters#
| 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. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.create(params)
useCompleteOrganicSignup#
Create a first-time organic signup workspace using the submitted organization name, timezone, and currency, then join the default demo org as a viewer and switch the active organization to the demo workspace.
import { useCompleteOrganicSignup } from '@brandwave/react';
const { mutate, isPending } = useCompleteOrganicSignup();
mutate({
userId: 'user_abc123',
name: 'My Campaign',
});Parameters#
| 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. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.completeOrganicSignup(params)
useUpdateOrganization#
Update an organization's name, description, timezone, currency, conversion value for ROI calculations, or attribution window.
import { useUpdateOrganization } from '@brandwave/react';
const { mutate, isPending } = useUpdateOrganization();
mutate({
id: 'abc-123',
});Parameters#
| 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). |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.update(params)
useDeleteOrganization#
Permanently delete an organization and all associated data.
import { useDeleteOrganization } from '@brandwave/react';
const { mutate, isPending } = useDeleteOrganization();
mutate({
id: 'abc-123',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Organization identifier to delete. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.delete(params)
Destructive action
useListOrganizationUsers#
List users in an organization with pagination and search.
import { useListOrganizationUsers } from '@brandwave/react';
const { data, isLoading } = useListOrganizationUsers({
pageIndex: 0,
pageSize: 25,
organizationId: 'org_123',
});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.organizations.users.list(params)
useAddOrganizationUser#
Add an existing user to an organization with a specified role.
import { useAddOrganizationUser } from '@brandwave/react';
const { mutate, isPending } = useAddOrganizationUser();
mutate({
organizationId: 'org_123',
userId: 'user_abc123',
role: 'member',
});Parameters#
| 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). |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.users.add(params)
useUpdateOrganizationUserRole#
Update a user's role within an organization.
import { useUpdateOrganizationUserRole } from '@brandwave/react';
const { mutate, isPending } = useUpdateOrganizationUserRole();
mutate({
organizationId: 'org_123',
userId: 'user_abc123',
role: 'member',
});Parameters#
| 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). |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.users.updateRole(params)
useRemoveOrganizationUser#
Remove a user's membership from an organization.
import { useRemoveOrganizationUser } from '@brandwave/react';
const { mutate, isPending } = useRemoveOrganizationUser();
mutate({
organizationId: 'org_123',
userId: 'user_abc123',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| userId | string (UUID) | Required | User identifier to remove. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.users.remove(params)
useInviteOrganizationUser#
Invite a user to an organization by email.
import { useInviteOrganizationUser } from '@brandwave/react';
const { mutate, isPending } = useInviteOrganizationUser();
mutate({
email: 'user@example.com',
organizationId: 'org_123',
role: 'member',
});Parameters#
| 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). |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.users.invite(params)
Authorization required
useAcceptOrganizationInvite#
Accept a pending organization invite.
import { useAcceptOrganizationInvite } from '@brandwave/react';
const { mutate, isPending } = useAcceptOrganizationInvite();
mutate({
organizationId: 'org_123',
userId: 'user_abc123',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| userId | string (UUID) | Required | User identifier accepting the invite. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.users.acceptInvite(params)
useDeclineOrganizationInvite#
Decline a pending organization invite.
import { useDeclineOrganizationInvite } from '@brandwave/react';
const { mutate, isPending } = useDeclineOrganizationInvite();
mutate({
organizationId: 'org_123',
userId: 'user_abc123',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| organizationId | string (UUID) | Required | Organization identifier. |
| userId | string (UUID) | Required | User identifier declining the invite. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.users.declineInvite(params)
useProcessInviteSignup#
Process invite metadata for a newly signed-up user.
import { useProcessInviteSignup } from '@brandwave/react';
const { mutate, isPending } = useProcessInviteSignup();
mutate({
userId: 'user_abc123',
});Parameters#
| Name | Type | Required | Description |
|---|---|---|---|
| userId | string (UUID) | Required | Authenticated user whose invite metadata should be processed. |
Response#
Returns { data } with the result.
Underlying SDK method: bw.organizations.users.processInviteSignup()