PUT /api/businesses/{BusinessID}/groupsettings

Updates the configurable group settings for a business on the platform.

Note: When you change a setting, it might take up to five minutes for the change to take effect.

Authorization Roles/Permissions: Site Admin.

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/businesses/{BusinessID}/groupsettings

Sample Request

The example below shows a request to update the group settings for the specified business. This request disables ratings and reviews for groups.

Sample Request URL

https://{hostname}/api//businesses/tenantbusiness.acmepaymentscorp/groupsettings

Sample request headers

Accept: application/json
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body: application/json

{
  "GroupSupport" : "com.soa.feature.enabled",
  "PublicGroupSupport" : "com.soa.feature.enabled",
  "PublicGroupBoardSupport" : "com.soa.feature.enabled",
  "PublicGroupRatingsSupport" : "com.soa.feature.disabled",
  "PublicGroupReviewsSupport" : "com.soa.feature.disabled",
  "PrivateGroupSupport" : "com.soa.feature.enabled",
  "PrivateGroupBoardSupport" : "com.soa.feature.enabled",
  "PrivateGroupRatingsSupport" : "com.soa.feature.disabled",
  "PrivateGroupReviewsSupport" : "com.soa.feature.disabled",
  "GroupMemberWorkflowDefKey" : "workflow:definition:application-team-mbr",
  "GroupCommentWorkflowDefKey" : "workflow:definition:comment"
}

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
BusinessID	Path	string	Required	The unique ID for a specific business organization on the platform.
BusinessGroupSettings	Body	BusinessGroupSettings	Required	Default settings to apply to all groups within the business, unless specified otherwise at a lower level.

Response

If successful, this operation returns HTTP status code 200, with the updated group settings.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Content-Type: application/json
Expires: Sat, 07 Feb 2015 19:55:01 GMT

Sample response body: application/json

{
  "GroupSupport" : "com.soa.feature.enabled",
  "PublicGroupSupport" : "com.soa.feature.enabled",
  "PublicGroupBoardSupport" : "com.soa.feature.enabled",
  "PublicGroupRatingsSupport" : "com.soa.feature.disabled",
  "PublicGroupReviewsSupport" : "com.soa.feature.disabled",
  "PrivateGroupSupport" : "com.soa.feature.enabled",
  "PrivateGroupBoardSupport" : "com.soa.feature.enabled",
  "PrivateGroupRatingsSupport" : "com.soa.feature.disabled",
  "PrivateGroupReviewsSupport" : "com.soa.feature.disabled",
  "GroupMemberWorkflowDefKey" : "workflow:definition:application-team-mbr",
  "GroupCommentWorkflowDefKey" : "workflow:definition:comment"
}

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
BusinessGroupSettings	BusinessGroupSettings	Default settings to apply to all groups within the business, unless specified otherwise at a lower level.

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