API v1 Documentation
Client API > Response
Client API > Contacts
Client API > Display
Client API > Environment
Client API > User
Management API > Action Class
Management API > Attribute Class
Management API > Contact Attribute Keys
Management API > Contact Attributes
Management API > Contacts
Management API > Me
Management API > People
Management API > Response
Management API > Storage
Management API > Survey
Management API > Webhook
Health
Create or Identify User
Endpoint for creating or identifying a user within the specified environment. If the user already exists, this will identify them and potentially update user attributes. If they donβt exist, it will create a new user.
POST
/
api
/
v1
/
client
/
{environmentId}
/
user
curl --request POST \
--url http:///%7B{baseurl}%7D/api/v1/client/{environmentId}/user \
--header 'Content-Type: application/json' \
--data '{
"attributes": {
"plan": "free"
},
"userId": "hello-user"
}'
{
"data": {
"state": {
"data": {
"displays": [
{
"createdAt": "2025-02-03T11:23:13.050Z",
"surveyId": "cm6orqtdd000a19wjhnbces5s"
}
],
"lastDisplayAt": "2025-02-03T11:23:13.050Z",
"responses": [
"cm6orqtdd000a19wjhnbces5s"
],
"segments": [
"cm6onrezn000hw2ahcokiz41v"
],
"userId": "hello-user"
},
"expiresAt": "2025-02-03T11:23:13.050Z"
}
}
}
Path Parameters
Body
application/json Β· object
Response
200
application/json
OK
Example:
"2025-02-03T11:23:13.050Z"
Example:
"hello-user"
Example:
"2025-02-03T11:23:13.050Z"
Was this page helpful?
curl --request POST \
--url http:///%7B{baseurl}%7D/api/v1/client/{environmentId}/user \
--header 'Content-Type: application/json' \
--data '{
"attributes": {
"plan": "free"
},
"userId": "hello-user"
}'
{
"data": {
"state": {
"data": {
"displays": [
{
"createdAt": "2025-02-03T11:23:13.050Z",
"surveyId": "cm6orqtdd000a19wjhnbces5s"
}
],
"lastDisplayAt": "2025-02-03T11:23:13.050Z",
"responses": [
"cm6orqtdd000a19wjhnbces5s"
],
"segments": [
"cm6onrezn000hw2ahcokiz41v"
],
"userId": "hello-user"
},
"expiresAt": "2025-02-03T11:23:13.050Z"
}
}
}