How can we help?


0 results found

Users/Patch or Users/Put

PUT /odata/Users/Put/[userId]

– OR –

PATCH /odata/Users/Patch/userId


To update an existing Axonize user.

See the following for request and response details ‒

See Also

Request ‒ Users/Patch or Put

In the request, specify the ID of the user whose definition to change and the name of the property(s) to change. These properties are described in Users/Post.

For the Patch request, all unspecified fields remain unchanged.

For the Put request, all unspecified fields are assigned default values.

Property Type Description Mandatory
userId String This is the unique identifier automatically assigned by Axonize when a user is created. This userId is returned in the response of the Users/Post. Y

Example JSON Users/Patch Request

The following is an example of changing a user’s username to test.

curl -X PATCH \ \

-H ‘Authorization: Token’ \

  -H ‘Content-Type: application/json’ \

  -H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22771E’ \

  -d ‘{



Response ‒ Users/Patch or Put

Property Type Description
createDate, createUser, updateDate, updateUser See Common Response Properties.

Example JSON Users/Patch/Put Response

Status 204 – No Content. The server has successfully fulfilled the request.