Update User

PUT /users/:user_id/

---

URL Example

https://system_domain/api/v2/users/123/

---

PATH Parameters

Parameter	Type	Required	Description
user_id	number	Yes	User ID

Request Body Parameters (JSON)

Parameter	Type	Required	Description
name	string	No	User name
email	string	No	User email
password	string	No	User password
group_id	number	No	User group ID
department	array	No	IDs of accessible departments
lastname	string	No	Last name
alias	string	No	Alias
phone	string	No	Phone
skype	string	No	Skype
website	string	No	Website address
organization	string	No	Name of a new or existing company; If filled, the "organiz_id" field is ignored
organiz_id	number	No	ID of an existing company; Ignored if "organization" is filled
status	string	No	User status: active - active; disabled - blocked; fired - terminated
language	string	No	User language
notifications	number	No	Email notifications: 0 - disabled; 1 - enabled
user_status	string	No	User activity status
custom_fields	object	No	Array of custom contact fields

---

Request Body Example (JSON)

{
    "name": "John",
    "email": "[email protected]",
    "department": [1],
    "password": "abc123",
    "group_id": 1,
    "lastname": "Doe", // use "" for empty value
    "phone": "+7 123 123-45-67", // use "" for empty value
    "skype": "skype", // use "" for empty value
    "website": "example.com", // use "" for empty value
    "organization": "New organization", // use "" for empty value
    // "organiz_id": 1, // Ignored if "organization" is filled
    "status": "active",
    "language": "en",
    "notifications": 0,
    "user_status": "online",
    "custom_fields": {
        "113": "Field value of type (Text Field)", // Example for field type "Text Field" (ID = 113), use "" for empty value
        "114": "Field value of type (Text Area)", // Example for field type "Text Area" (ID = 114), use "" for empty value
        "115": "450", // Example for field type "Dropdown List" (ID = 115), specify ID of the field value, use "" for empty value
        "116": {  // Example for field type "Related Fields" (ID = 116)
            "1": 452, // ID field value of the first level
            "2": 454  // ID field value of the second level
        },
        // "116": {
        //     "1": 0, // Structure for specifying empty value for "Related Fields" type
        // },
        "117": "1", // Example for field type "Checkbox" (ID = 117), use "" for empty value
        "118": "01.01.2027", // Example for field type "Date" (ID = 118), use "" for empty value
        "119": "1" // Example for field type "Number Field" (ID = 119), use "" for empty value
    }
}

---

Response example

{
    "data": {
        "id": 1,
        "date_created": "2025-10-17 11:08:43",
        "date_updated": "2025-10-17 11:08:43",
        "name": "John",
        "lastname": "Doe",
        "alias": "Technical support",
        "email": "[email protected]",
        "phone": "+7 123 123-45-67",
        "skype": "skype",
        "website": "example.com",
        "organization": {
            "id": "1",
            "name": "New organization",
            "domains": "",
            "address": "",
            "phone": "",
            "email": "",
            "web": ""
        },
        "status": "active",
        "language": "en",
        "notifications": "1",
        "group": {
            "id": 1,
            "type": "user",
            "name": {
                "en": "Client",
                "ru": "Клиент",
                "ua": "-"
            },
            "disable": 0
        },
        "ldap_username": null,
        "user_status": "online",
        "department": [
            1
        ],
        "custom_fields": [
            {
                "id": 113,
                "field_type": "text",
                "field_value": "Field value of type (Text Field)"
            },
            {
                "id": 114,
                "field_type": "textarea",
                "field_value": "Field value of type (Text Area)"
            },
            {
                "id": 115,
                "field_type": "select",
                "field_value": {
                    "id": 450,
                    "name": {
                        "en": "Meaning 1",
                        "ru": "",
                        "ua": ""
                    }
                }
            },
            {
                "id": 116,
                "field_type": "hierarchy",
                "field_value": {
                    "1": {
                        "id": 452,
                        "name": {
                            "en": "First-level parent element",
                            "ru": "",
                            "ua": ""
                        }
                    },
                    "2": {
                        "id": 454,
                        "name": {
                            "en": "Second-level child element",
                            "ru": "",
                            "ua": ""
                        }
                    }
                }
            },
            {
                "id": 117,
                "field_type": "checkbox",
                "field_value": 1
            },
            {
                "id": 118,
                "field_type": "date",
                "field_value": "01.01.2027"
            },
            {
                "id": 119,
                "field_type": "number",
                "field_value": "1"
            }
        ]
    }
}