USusepylon
user

Update a user

Changed on

Updates an existing user. Only provided fields are modified.

Rate limit: 120 requests per minute

patch/users/{id}

Request

  • Base URL
    https://api.usepylon.com
  • URL
    https://api.usepylon.com/users/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the user to update.

Request body

avatar_urlstring

The avatar URL of the user. Must be a square .png, .jpg or .jpeg.

is_deactivatedboolean

Whether the user is deactivated. Changing it requires admin permissions. Deactivating revokes the user's API tokens, removes their team schedules and skills, disconnects their calendars, and reassigns their open issues in the background. Reactivating does not restore any of these. Users provisioned through SCIM must be deactivated and reactivated in the identity provider.

namestring

The name of the user.

reassign_open_issues_to_user_idstring

The ID of the user to reassign the deactivated user's open issues to. Only valid with is_deactivated: true. If omitted, the issues are unassigned.

role_idstring

The role_id of the user.

statusstring

The new status for the user: active, away, out_of_office, or a custom status slug from GET /user-statuses.

Example request

{
  "status": "active"
}

Response

request_idstring required

The request ID for tracking.

Example response

{
  "data": {
    "status": "active"
  }
}

Changes

  • 69a0bee18b33Revision changes
    • info

      added the optional property / to the response with the status

  • 08e3adb18ae9Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property