Invite a user to a business.
Invite a user to join a business.
Request
- business_idstring [uuid]Required
A unique identifier for the entity.
Example:ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a
- email_addressstringRequired
The email address of a user in or invited to a business.
Maximum length:319Example:"discovery@gmail.com" - business_rolestringRequired
The role of the user in a business.
Allowed values:"BUSINESS_ADMIN","BUSINESS_MEMBER" Optional list of ad account invitations to include with the business invitation. If not provided, the user will only have business-level access.
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"
Response
Metadata of user's invitation 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" - email_addressstring
The email address of a user in or invited to a business.
Maximum length:319Example:"discovery@gmail.com" - invitation_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" 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"
Response sample
{ "id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a", "role": "BUSINESS_ADMIN", "email_address": "discovery@gmail.com", "invitation_status": "ACCEPTED", "created_at": "2026-01-23T04:56:07Z", "updated_at": "2026-01-23T04:56:07Z", "ad_account_invitations": [ { "ad_account_id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a", "role": "AD_ACCOUNT_ADMIN" } ]}