Create or Identify User

Endpoint for creating or identifying a user within the specified Workspace. 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. Note - Environments are deprecated. Use Workspace/workspaceId terminology.

POST /client/{workspaceId}/user

Create or Identify User

cURL

curl --request POST \
  --url https://app.formbricks.com/api/v2/client/{workspaceId}/user \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "user123",
  "attributes": {}
}
'

200

{
  "userId": "user123",
  "state": "identified"
}

Path Parameters

workspaceId · string · required

The ID of the Workspace. Deprecated alias environmentId.

Body

application/json

The body is of type object.

Response

200 - application/json

OK

The response is of type object.