Skip to main content
POST
Create a user
Use sandbox environment for testing. Sandbox users do not affect production analytics.

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Headers

Idempotency-Key
string

Client-generated key that makes retries safe.

Body

application/json
environment
enum<string>
required

Environment the user belongs to.

Available options:
prod,
sandbox
Example:

"prod"

Response

User created

object
enum<string>
required
Available options:
user
id
string
required

Qonversion User ID. SDK-generated IDs are prefixed with QON_.

Example:

"QON_3af4c5b8a4d24f21b72e9d0c8aef9d4e"

url
string
required

Canonical API path.

Example:

"/v4/users/QON_3af4c5b8a4d24f21b72e9d0c8aef9d4e"

environment
enum<string>
required

Environment the user belongs to.

Available options:
prod,
sandbox
Example:

"prod"

created_at
string<date-time>
required

Creation timestamp (ISO 8601 UTC).

Example:

"2025-09-15T12:30:00Z"

identity_id
string | null

External identity identifier, if set. Null when not linked to an identity.

Example:

"awesome_user"