PUT /api/businesses/{BusinessID}/usersettings

Updates the configurable user 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}/usersettings

Sample Request

The example below shows a request to update the user settings for the specified business. This example includes setting a custom workflow.

Sample Request URL

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

Sample request headers

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

Sample request body

{
  "NewsUpdateNotification": "com.soa.feature.enabled",
  "EnforceChallengesSetupOnLogin": "com.soa.feature.disabled",
  "SelfSignup": "com.soa.feature.enabled",
  "InviteUnregisteredUsers": "com.soa.feature.enabled",
  "ResetValidCodeHours": 48,
  "UpdateEmailValidCodeHours": 48,
  "SignupUserValidDays": 7,
  "AddedUserValidDays": 30,
  "InvitedUserValidDays": 7,
  "TopApisCountAllowed": 8
}

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.
BusinessUserSettings	Body	BusinessUserSettings	Required	Default settings to apply to all users within the business.

Response

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

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Thu, 11 Jun 2020 21:43:22 GMT

Sample response body: application/json

{
  "NewsUpdateNotification": "com.soa.feature.enabled",
  "EnforceChallengesSetupOnLogin": "com.soa.feature.disabled",
  "SelfSignup": "com.soa.feature.enabled",
  "InviteUnregisteredUsers": "com.soa.feature.enabled",
  "ResetValidCodeHours": 48,
  "UpdateEmailValidCodeHours": 48,
  "SignupUserValidDays": 7,
  "AddedUserValidDays": 30,
  "InvitedUserValidDays": 7,
  "TopApisCountAllowed": 8
}

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
BusinessUserSettings	BusinessUserSettings	Default settings to apply to all users within the business.

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
400	Bad request: Returned if the client sends a malformed request; for example, invalid parameters or body content.For example, you might get this response if you send an incorrect JSON object in the request, or specified the wrong media type in the Content-Type header.
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. You would also get it 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