Accept a user invitation to join a business.
Accept a user invitation to join a business. This will create a new business user profile and add them to the specified business
Request
- business_idstring [uuid]Required
A unique identifier for the entity.
Example:ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
- namestringRequired
The display name of a user in or invited to a business. It will be defined for active users, and null for pending users.
Example:"John Doe" - email_addressstringRequired
The email address of a user in or invited to a business.
Maximum length:319Example:"discovery@gmail.com" - has_marketing_opt_inbooleanRequired
Indicates if user has opted into marketing.
- invitation_idstring [uuid]Required
A unique identifier for the entity.
Example:"ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
Response
Metadata of user's permission to a business.
- idstring [uuid]
A unique identifier for the entity.
Example:"ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a" - rolestring
The role of the user in a business.
Allowed values:"BUSINESS_ADMIN","BUSINESS_MEMBER" - namestring
The display name of a user in or invited to a business. It will be defined for active users, and null for pending users.
Example:"John Doe" - email_addressstring
The email address of a user in or invited to a business.
Maximum length:319Example:"discovery@gmail.com" - member_idstring
A unique identifier for a business member.
Example:"125335bb419b494dbedd31105d56a49a" - permission_statusstring
Status of a user's permission to a business
Allowed values:"ACCEPTED","PENDING","CANCELLED" - created_atstring [date-time]
Date the entity was created. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ
Example:"2026-01-23T04:56:07Z" - updated_atstring [date-time]
Date the entity was updated. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ
Example:"2026-01-23T04:56:07Z" - business_idstring [uuid]
A unique identifier for the entity.
Example:"ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a" - has_marketing_opt_inboolean
Indicates if user has opted into marketing.
List of ad account invitations included with the business invitation. Empty if no ad account invitations were provided.
An invitation to join an ad account with a specific role.
- ad_account_idstring [uuid]Required
A unique identifier for the entity.
Example:"ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a" - rolestringRequired
The role of a user in an ad account.
Allowed values:"AD_ACCOUNT_ADMIN","AD_ACCOUNT_CONTRIBUTOR","AD_ACCOUNT_VIEWER"
- assigned_ad_accountsinteger
Number of ad accounts a pending member has been invited to or an active member is assigned to. 0 if not assigned to any.
Minimum value:0
Response sample
{ "id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a", "role": "BUSINESS_ADMIN", "name": "John Doe", "email_address": "discovery@gmail.com", "member_id": "125335bb419b494dbedd31105d56a49a", "permission_status": "ACCEPTED", "created_at": "2026-01-23T04:56:07Z", "updated_at": "2026-01-23T04:56:07Z", "business_id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a", "has_marketing_opt_in": false, "ad_account_invitations": [ { "ad_account_id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a", "role": "AD_ACCOUNT_ADMIN" } ], "assigned_ad_accounts": 0}