Sign in

v53

latestOpenAPI 3.1.1raw.githubusercontent.com2026-07-264065213.4 KB
Users

Create a user

Creates a new User object.

post/accounts/{account_id}/users

Path parameters

account_idstring required

The account for which the user should be created.

Example:acct_01j9a43avnfqzbjfch6pygv1td

Request body

first_namestring required

The user's first name.

last_namestring

The user's last name.

metadataMetadata

Set of key-value pairs that will be stored with the object.

photo_urlstring uri

URL of a photo to be used as the user's avatar.

Example request

{
  "first_name": "Brian",
  "last_name": "O'Conner",
  "metadata": {
    "email": "boconner@toretti.family",
    "user_id": "1234"
  },
  "photo_url": "https://toretti.family/people/brian.jpg"
}

Response

Created user

first_namestring required

The user's first name.

idstring

Unique identifier for the object.

last_namestring

The user's last name.

metadataMetadata

Set of key-value pairs that will be stored with the object.

photo_urlstring uri

URL of a photo to be used as the user's avatar.

Example response

{
  "first_name": "Brian",
  "id": "usr_01j9dwavghe1ttppewekjjkfrx",
  "last_name": "O'Conner",
  "metadata": {
    "email": "boconner@toretti.family",
    "user_id": "1234"
  },
  "photo_url": "https://toretti.family/people/brian.jpg"
}