Skip to main content
POST
/
end-users
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "organization_id": "<string>",
  "external_id": "<string>",
  "email": "<string>",
  "metadata": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Input for creating a new end user. Requires external_id (your system's user identifier). Email and metadata are optional.

​
organization_id
string
required
​
external_id
string
required
​
email
string | null
​
metadata
string | null

Response

OK

End user resource representing a user who interacts with embedded AI widgets. Identified by external_id from the embedding site.

​
id
string
required
​
organization_id
string
required
​
external_id
string
required
​
email
string | null
required
​
metadata
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required