Users

Create a user in your organization

post/users

Request

  • Base URL
    /v1 (relative, and the document’s source URL is not known)
  • URL
    /v1/users
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token

Request body

emailstring required

The email address for the new user

firstNamestring required

The first name of the new user

lastNamestring required

The last name of the new user

Example request

{
  "email": "new.user@example.com",
  "firstName": "New",
  "lastName": "User"
}

Response

Created

idstring

The user ID

emailstring

The user email address

firstNamestring

The user first name

lastNamestring

The user last name

statusstring

The user status (e.g., ACTIVE, INACTIVE)

createdAtstring date-time

When the user was created

Example response

{
  "id": "u-456",
  "email": "jane.doe@example.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "status": "ACTIVE",
  "createdAt": "2025-06-01T09:00:00Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.