UserResource

Update a user

Updates profile and settings for a user provisioned in the organization.

Required API key permissions

  • Scope: users:update
  • Accepted key types: organization API key (org-wide), personal access token (org-wide)
  • Access: User-linked keys (personal access tokens) may only act on their own user.
  • Self access: personal access tokens may write their linked user's resource even when the user belongs to multiple organizations.
  • Notes: Personal access tokens may only update their linked user.
put/api/public/v1/user/{id}

Request

Path parameters

idstring uuid required

Query parameters

organizationIdstring uuid

Request body

emailstring nullable
displayNamestring nullable
phoneNumberstring nullable
timeZoneIdstring nullable
disableWeeklyIncidentEngagementReportboolean nullable

Response

OK

idstring uuid
emailstring nullable
userNamestring nullable
displayNamestring nullable
phoneNumberstring nullable
timeZoneIdstring nullable
disableWeeklyIncidentEngagementReportboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.