Make updates to a user.
Table of Contents
|MIME type of the request body|
|Expected MIME type of the response body|
|string||The id you provided as |
No URL parameters are defined for this request.
The request body must be a valid, properly formatted JSON string which represents an array of Patch operations. The Patch operation is made up of the following data elements.
Operation to perform on the specified data element. Valid operations are:
Data element to be updated, specified in "path" format with a leading "/". Valid paths are:
|any||required||The new value for the data element specified by |
Successful Response HTTP Status Codes
A successful response will have one of the following HTTP Status Codes:
|HTTP Status Code||Usage|
|The requested resource was found and updated successfully|
Successful Response Headers
No additional headers are included with the response.
Successful Response Body
No response body is returned.
Successful Response Examples
Error Response HTTP Status Codes
The following HTTP status codes will be used specific to this endpoint:
|HTTP Status Code||Code||Message||Possible Causes|
|2||User not found with id: user-id||The specified ID does not exist|
|5||No properties received for update||The request does not include any Patch operations where "op" = "replace"|
|4||Property path cannot be updated||An invalid or read-only path was specified|
|1||Failed updating user||An unspecified validation has failed, or database exception has occurred|
Error Response Examples