Partially update a single user in an organization

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2027-01-31.

Description

Partially update the properties of a User within an Organization.

Options

Path	PATCH Operations Supported
/givenName	replace
/familyName	replace
/displayName	replace
/username	replace
/email	replace

PATCH /prototype/admin/organizations/{organizationId}/users/{userId}

Required OAuth Scopes

organization:write

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
organizationId	path	string(uuid)	true	The unique identifier of the organization
userId	path	string	true	The unique identifier of the user
body	body	JSONPatchDocument	true	Editable details about the User.

Body parameter example

[
  {
    "op": "replace",
    "path": "/displayName",
    "value": "Smith, Jane"
  }
]

Code Samples

curl

curl -X PATCH https://api.app.wdesk.com/prototype/admin/organizations/{organizationId}/users/{userId} \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http PATCH https://api.app.wdesk.com/prototype/admin/organizations/{organizationId}/users/{userId} \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=PATCH "https://api.app.wdesk.com/prototype/admin/organizations/{organizationId}/users/{userId}" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.app.wdesk.com/prototype/admin/organizations/{organizationId}/users/{userId}', headers = headers)

print(r.json())

Returns

200 - OK

Returns an OrganizationUser object containing details about the updated OrganizationUser.

400 - Bad Request

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

401 - Unauthorized

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Forbidden

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not Found

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

409 - Conflict

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

429 - Too Many Requests

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Internal Server Error

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

503 - Service Unavailable

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses

200 Response

{
  "created": {
    "dateTime": "2019-10-01T15:03:27Z"
  },
  "displayName": "Jane Smith",
  "email": "jane.smith@example.com",
  "familyName": "Smith",
  "givenName": "Jane",
  "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
  "modified": {
    "dateTime": "2021-07-14T08:03:02Z"
  },
  "status": "active",
  "username": "jane.smith@example.com"
}

Bad Request

{
  "code": "400BadRequest",
  "message": "The request was unacceptable, often due to a missing or invalid parameter"
}

Unauthorized

{
  "code": "401Unauthorized",
  "message": "No valid API token provided"
}

Forbidden

{
  "code": "403Forbidden",
  "message": "The API token does not have permissions to perform the request"
}

Not Found

{
  "code": "404NotFound",
  "message": "The requested resource could not be found"
}

Conflict

{
  "code": "409Conflict",
  "message": "The request conflicts with another request"
}

Too Many Requests

{
  "code": "429TooManyRequests",
  "message": "Too many requests have been made against the API in too short a time"
}

Internal Server Error

{
  "code": "500InternalServerError",
  "message": "The server encountered an unexpected condition that prevented it from fulfilling the request"
}

Service Unavailable

{
  "code": "503ServiceUnavailable",
  "message": "The server cannot handle the request due to a temporary overload or scheduled maintenance"
}