Authorized users

Create authorized user

Changed on

Adds a user to an account's team as an authorized user with the given role.

Required permissions:

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

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/authorized_users
  • Auth: HTTP bearer

Request body

account_idstring required

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

role'owner' | 'admin' | 'partner' | '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

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

Response

A successful response

idstring required

The unique identifier for the authorized user.

role'owner' | 'admin' | 'partner' | '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

  • c19acf2e2548Revision changes
    • warning

      added the new partner enum value to the response property for the response status

    • info

      added the new partner enum value to the request property

  • 697924df40d1Revision changes
    • breaking

      added the new required request property

    • warning

      removed the request property