Update User

PUT

https://platform-api.convirza.com/v3/users/{id}

Users

Last modified:2026-04-03 14:27:57

Performs a full update of a user record. All fields in the request body overwrite the existing values.

When to use PUT vs PATCH
Use PUT when you want to update the entire user profile in one operation. Use PATCH when you only need to update one or two specific fields.

Constraints

The email must remain globally unique — changing to an address already in use is rejected.

The ct_user_ou_id (org unit) must be within the authenticated admin's accessible hierarchy.

updated_at is automatically set to the current server timestamp.

Response
Returns a success flag and the updated user ID. Retrieve the full updated profile using GET /users/:id.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

User updated successfully

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "userId": 12345
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-04-03 14:27:57

Get User Details

Partial Update User