Skip to main content
POST
Create authorized user
Required permissions:
  • authorized_user:create
  • member:email:read

Autorisations

Authorization
string
header
requis

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

authorized_user:create
member:email:read

Corps

application/json

Parameters for CreateAuthorizedUser

account_id
string
requis

The ID of the company to add the authorized user to.

Exemple:

"biz_xxxxxxxxxxxxxx"

role
enum<string>
requis

The role to assign to the authorized user within the company. Supported roles: 'moderator', 'sales_manager'.

Options disponibles:
owner,
admin,
partner,
sales_manager,
moderator,
advertiser
user_id
string
requis

The ID of the user to add as an authorized user.

Exemple:

"user_xxxxxxxxxxxxx"

elevation
object | null

Re-authentication proof required to perform this sensitive action.

send_emails
boolean | null

Whether to send notification emails to the user on creation.

Réponse

A successful response

A user who belongs to a company's team with access determined by their assigned role.

company
object
requis

The company this authorized user has access to.

id
string
requis

The team member's ID. It may start with ausr_ or mber_; treat it as opaque.

Exemple:

"ausr_xxxxxxxxxxxxx"

role
enum<string>
requis

The permission role assigned to this authorized user within the company.

Options disponibles:
owner,
admin,
partner,
sales_manager,
moderator,
advertiser,
app_manager,
support,
manager,
workforce,
custom
user
object
requis

The user account linked to this authorized user record.