PUT /api/groups/{GroupID}

Changes one or more values relating to the specified group.

Authorization Roles/Permissions: Must be logged in. Only an authorized user can modify a group. Note that if the platform has additional constraints set regarding who has permission to modify a group, the permissions must match or the operation will fail.

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/groups/{GroupID}

Sample Request

The example below shows a request to modify the specified group.

Sample Request URL

https://{hostname}/api/groups/group24147.acmepaymentscorp

Sample request headers

Accept: application/json
Content-type: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "GroupID":"group24147.acmepaymentscorp",
  "Name":"LEAD Tier Two",
  "Description":"League of Extraordinary Application Developers",
  "Tag":[
    "brilliant",
    "advanced",
    "innovative",
    "league"
  ],
  "Visibility":"Limited",
  "PictureID":1520,
  "GroupType":"com.soa.group.type.independent"
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/xml application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
GroupID	Path	string	Required	The unique ID for a specific group.
Group	Body	Group	Required	Contains information about a group on the platform.Required properties: Name, Description, Visibility, GroupType, GroupID.

Response

If successful, this operation returns HTTP status code 200, with the updated Group object.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: application/json
Date: Tue, 11 Jun 2013 21:21:58 GMT

Sample response body: application/json

{
  "GroupID" : "group24147.acmepaymentscorp",
  "Name" : "LEAD Tier Two",
  "Description" : "League of Extraordinary Application Developers",
  "Tag" : [ "brilliant", "advanced", "innovative", "league" ],
  "Visibility" : "Limited",
  "PictureID" : 1520,
  "GroupType" : "com.soa.group.type.independent"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Response Body

Name	Type	Description
Group	Group	Information about the group, including the changes.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
405	Method Not Allowed. You might get this if there is an error in the URL, or if you used the wrong HTTP verb.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics