PUT api/groups/{id}

Updates the details of an existing user group.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the group to be updated.	integer	Required

Body Parameters

An object containing the updated name, description, and tags for the group.

UpdateGroupDTO

Name	Description	Type	Additional information
name	Group Name	string	None.
description	Group description	string	None.
tags	Group tags, comma seperated list of tags	string	None.

Request Formats

application/json, text/json, application/scim+json

Sample:

{
  "name": "sample string 1",
  "description": "sample string 2",
  "tags": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateGroupDTO'.

Response Information

Resource Description

On success: HTTP 200 OK with a confirmation of the update. On failure: HTTP 400 Bad Request with a specific error message.

IHttpActionResult

None.

Response Formats

application/json, text/json, application/scim+json

Sample:

Sample not available.