Partial Update User

PATCH

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

Users

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

Applies a partial update to a user record, modifying only the fields present in the request body. All fields not included in the payload retain their existing values.

Common use cases

Change a user's role: { "role_id": 3 }

Deactivate a user: { "user_status": "inactive" }

Update ring-to number: { "agent_ring_to": "+15559876543" }

Move a user to another group: { "ct_user_ou_id": 2050 }

Constraints

At least one field must be present in the request body.

If username (email) is changed, the new value must be globally unique.

The user must not already be in a deleted status.

updated_at is automatically refreshed on every successful PATCH.

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 PATCH '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

Update User

Delete User