Sign in
Authorized users

Create authorized user

Add a new authorized user to a company.

Required permissions:

  • authorized_user:create
  • member:email:read
post/authorized_users

Request body

company_idstring required

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

role'owner' | 'admin' | 'sales_manager' | 'moderator' | 'advertiser' required

System roles accepted by legacy authorized-user mutations

send_emailsboolean nullable

Whether to send notification emails to the user on creation.

user_idstring required

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

Example request

{
  "company_id": "biz_xxxxxxxxxxxxxx",
  "user_id": "user_xxxxxxxxxxxxx"
}

Response

A successful response

idstring required

The unique identifier for the authorized user.

role'owner' | 'admin' | 'sales_manager' | 'moderator' | 'advertiser' | 'app_manager' | 'support' | 'manager' | 'workforce' | 'custom' required

Possible roles an authorized user can have

Example response

{
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "Pickaxe"
  },
  "id": "ausr_xxxxxxxxxxxxx",
  "user": {
    "email": "john.doe@example.com",
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  }
}

Changes

Changed in 2 of the 41 revisions of this API.511

  • 48408451a1f05See the full diff
    • ▲

      removed the enum value app_manager of the request property role

      request-property-enum-value-removed

    • ▲

      removed the enum value custom of the request property role

      request-property-enum-value-removed

    • ▲

      removed the enum value manager of the request property role

      request-property-enum-value-removed

    • ▲

      removed the enum value support of the request property role

      request-property-enum-value-removed

    • ▲

      removed the enum value workforce of the request property role

      request-property-enum-value-removed

  • ae20b30817de11See the full diff
    • ●

      added the new workforce enum value to the role response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new workforce enum value to the request property role

      request-property-enum-value-added