Skip to main content
POST
/
widget
/
authenticate-user
Authenticate a widget user
curl --request POST \
  --url https://api.open.cx/widget/authenticate-user \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "name": "<string>",
  "avatar_url": "<string>",
  "phone": "<string>",
  "customData": {},
  "chat_context": "<string>",
  "http_action_overrides": {
    "query_params": {},
    "path_params": {},
    "body_params": {},
    "headers": {}
  }
}
'
{
  "token": "<string>",
  "contact": {
    "id": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
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,}$
​
name
string
​
avatar_url
string | null
​
phone
string
​
language
enum<string>
Available options:
en,
fr,
de,
nl,
pl,
pt,
es,
it,
ru,
ja,
ko,
zh,
ar,
tr,
sv,
da,
no,
fi,
el,
cs,
hu,
th,
vi,
id,
he,
hi,
uk,
ro,
bg,
hr,
sk,
sl,
sr,
et,
lv,
lt,
is,
ga,
ms,
tl,
fa,
bn,
ta,
te,
ur,
sw,
zu,
af,
sq,
hy,
az,
eu,
be,
bs,
ca,
cy,
ku,
ckb,
kmr
​
customData
object
​
chat_context
string
​
http_action_overrides
object

Response

Default Response

​
token
string
required

The JWT token to use for further requests

​
contact
object
required