Sign in
Users (By ID)

Update User by ID

Changed on

Updates a specific user by ID.

<i class="fa fa-warning"></i> Note

To delete a user, set deleted to true. You can un-delete by setting the deleted to null

put/users/{id}

Request

  • Base URL: https://api.kustomerapp.com/v1
  • URL: https://api.kustomerapp.com/v1/users/{id}
  • Auth: httpBearer (a scheme the document does not define)

Path parameters

idstring required
Example:<string>

Unique ID of the authorized user.

Request body

displayNamestring nullable
avatarUrlstring uri nullable
namestring
emailstring email
mobilestring phone-number-e164 nullable
emailSignaturestring nullable
deletedboolean nullable
passwordstring
currentPasswordstring
userType'user' | 'limited' | 'hourly'
roleGroupsstring[]
rolesstring[]

Response

Created

Changes