Sign in
beta.admin.users

Create Users

Create Organization members.

post/v1/admin/users

Request body

role_namesstring[] nullable

Simplified role names to assign. Mutually exclusive with 'roles'.

role_name'member' | 'billing_manager' | 'organization_admin' nullable

Deprecated single role name, kept for backward compatibility. Mutually exclusive with 'role'.

emailstring required

Email address of the user to create.

first_namestring required

First name of the user to create.

last_namestring required

Last name of the user to create.

subscription_typesPlanType[] nullable

Product seats to assign to the user.

Example request

[
  {
    "email": "alice.martin@example.com",
    "first_name": "Alice",
    "last_name": "Martin"
  }
]

Response

OK

invalid_emailsstring[] required

Email addresses that could not be created.

email_to_user_idobject required

Mapping from created user email to user identifier.

Changes