How can we help?


0 results found

Groups/Patch or Groups/Put

PUT /odata/Groups/[groupId]

– OR –

PATCH /odata/Groups/[groupId]


To update an existing Axonize Group.

See the following for request and response details ‒

See Also

Request ‒ Groups/Patch or Put

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

For the Patch endpoint, all unspecified fields remain unchanged.

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

Property Type Description Mandatory
id String This is the unique identifier automatically assigned by Axonize when a Group is created. This ID is returned in the response of the Groups/Post. Y
name String The Group’s name. Y (Only for Put)

Example JSON Groups/Patch Request

The following is an example of changing a Group’s name to test.

curl -X PATCH \ \

-H ‘Authorization: Token’ \

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

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

-d ‘{



Response ‒ Groups/Patch or Put

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

Example JSON Groups/Patch/Put Response

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