Sign in

v1

latestOpenAPI 3.1.02026-07-24145580597.0 KB
Users:v1:Users

Update users

Update individual or multiple users associated with the account using the provided details. You can specify updates either by their phone number or unique userID.

put/users/v1/users

Query parameters

editUsersByPhoneboolean

Optional flag to edit users by phone (default by user id).

Optional flag to edit users by phone (default by user id).

includeSmartGroupIdsboolean

Indicates whether to include smart group IDs in the response body for the updated user(s). Please note that setting this value to true may increase the request time significantly.

Indicates whether to include smart group IDs in the response body for the updated user(s). Please note that setting this value to true may increase the request time significantly.

Request body

firstNamestring

The user's first name

lastNamestring

The user's last name

phoneNumberstring

The user's phone number

userType'user' | 'manager' | 'owner'

An enumeration.

emailstring

The user's email (mandatory for managers and owners)

isArchivedboolean

The user status.Note that restoring a user is not applicable with the editUserByPhone field (you must provide the user ID).

userIdinteger

The user's unique id

profilePictureFileIdstring

The file ID obtained from the upload attachment endpoint (POST /attachments/v1/files/generate-upload-url) with featureType set to 'users'. Send an empty string to remove the current profile picture.

Response

Successful Response

requestIdstring