Create User

Creates a new user account and assigns them to an organizational unit with a specified role.

Business rules

The email address must be unique across the entire platform — duplicate emails are rejected with a conflict response.

The role_id must correspond to a valid role (Admin, Standard, ReadOnly).

The ct_user_org_unit_id (org unit) must exist and be within the authenticated admin's hierarchy.

A temporary default password is set automatically. The new user should be prompted to change it on first login.

Optional fields

user_ext_id — your own internal identifier to map this user to an external system.

timezone — defaults to the org unit timezone if not provided.

agent_ring_to — the phone number calls are forwarded to for this agent.

agent_code — numeric code used in IVR flows to identify this agent.

score_call / access_audio — enable scorecard and audio playback access respectively.

Response
Returns the new user's ct_user_id and a success flag. Use GET /users/:id to retrieve the full profile after creation.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location 'https://platform-api.convirza.com/v3/users' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "username": "admin@example.com", "first_name": "Admin", "last_name": "User", "ct_user_org_unit_id": 1001, "role": "Admin", "user_ext_id": "EXT-ADMIN-001", "user_status": "active", "aliases": null, "timezone": "America/New_York", "agent_ring_to": "+1234567890", "agent_code": 10, "score_call": true, "access_audio": true }'

Create User

Request

Responses