Update user.

patch

https://api.visualvisitor.com/api/v1/users/{id}

Minimal scope required: "users.update".

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique identifier of the user to update. This parameter is required and passed in the URL.

Query Params

customerId

string | null

Optional query parameter, allowing partners to perform this action on behalf of their customer.

api-version

string | null

Body Params

The JSON object containing the fields to update for the user.
Non-null or non-empty fields in this object will overwrite the corresponding fields in the existing user.

Represents the data required to update an existing user's information.

firstName

string | null

Optional, The user's first name.

lastName

string | null

Optional, the user's last name.

string | null

Optional, the user's email address.

phone

string | null

Optional, the user's phone number.

password

string | null

Optional, the user's new password.

timeZoneId

string | null

Optional, the user's time zone.

roleName

string | null

Optional, sets the user's role.
Required values can be retrieved from the endpoint: /api/v1/reference/roles.

active

boolean | null

Indicates if the user's account can log in.

Headers

X-Version

string | null

Responses

500

200Task completed returns the value "success".

400

401

403

404

429