Update details of user

PATCH {{baseUrl}}/api/v1/users/:user_id

This API helps update the details of a particular help center user.

OAuth Scope

  • Desk.contacts.UPDATE
  • Desk.settings.UPDATE

Request Params

KeyDatatypeRequiredDescription
helpCenterIdstringID of the help center from which the user must be updated
emailstringEmail ID of the user
statusstringActivation status of the user. Values supported are ACTIVE and DISABLED.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"lastAccessedTime":"2021-06-11T06:21:32.000Z","photoURL":"https://desk.zoho.com/portal/api/portalUser/17883000000094001/photo","contactId":"3313135931139","name":"Developer","id":"310975130121","label":{"preferences":{"shape":"RECTANGLE","bgColor":"#39B54A","textColor":"#FFFFFF"},"name":"Lock Label","id":"24073000002823026","logoUrl":null},"type":"ENDUSER","email":[{"emailAddress":"zylcare@zylker.com","isVerified":"false","isPrimary":"true"}],"status":"ACTIVE"}