PUT /api/businesses/{BusinessID}/alertsettings

Updates the configurable alert 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: Must have Modify permission for the resource. Site Admin or other authorized Admin.

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

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

Back to top

Sample Request

The example below shows a request to update the alert settings for the specified business.

Request URL

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

Sample request headers

Accept: application/json
Content-Type: application/json
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

{
  "AlertCommentWorkflowDefKey" : "workflow:definition:comment",
  "AutoPublish" : false,
"MarkdownSupport" : "com.soa.feature.enabled"
"ExternalLinkSupport" : "com.soa.feature.disabled" }

Back to top

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

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
BusinessID Path string Required The unique ID for a specific business organization on the platform.
alertSettings Body AlertSettings Required Contains information about the alert settings for the business.

Back to top

Response

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

Back to top

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
Expires:  Wed, 13 May 2015 12:00:00 GMT

Sample response body: application/json

{
  "AlertCommentWorkflowDefKey" : "workflow:definition:comment",
  "AutoPublish" : false,
"MarkdownSupport" : "com.soa.feature.enabled"
"ExternalLinkSupport" : "com.soa.feature.disabled" }

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/xml
Expires: Wed, 13 May 2015 12:00:00 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AlertSettings xmlns="http://soa.com/xsd/business/1.0" 
xmlns:ns2="http://soa.com/xsd/legals/1.0" xmlns:ns3="http://soa.com/xsd/dnmodel/1.0" 
xmlns:ns4="http://soa.com/xsd/api/1.0">
  <AlertCommentWorkflowDefKey>workflow:definition:comment</AlertCommentWorkflowDefKey>
  <AutoPublish>false</AutoPublish>
  <MarkdownSupport>com.soa.feature.enabled</MarkdownSupport>
  <ExternalLinkSupport>com.soa.feature.disabled</ExternalLinkSupport>
</AlertSettings>

Back to top

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

Back to top

Response Body

Name Type Description
AlertSettings AlertSettings Contains information about the alert settings for the business.

Back to top

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 invalid parameters or body content. For example, you might get this response if you use the wrong HTTP verb.
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.
404 The resource could not be found.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics