Skip to main content
POST
/
v2
/
users
Create a user
curl --request POST \
  --url https://api.example.com/v2/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "jsmith@example.com"
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
email
string<email>
required
Maximum string length: 255
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

201 - application/json
​
id
string
required
Pattern: ^usr_[0-9A-Za-z]{22}$
​
organizationId
string | null
required
Pattern: ^org_[0-9A-Za-z]{22}$
​
name
string
required
​
email
string<email>
required
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required