POST Messages/Action

Handles the response to an action card.

Request Information

URI Parameters

None.

Body Parameters

A hydrated ActionRequest object.

Object

None.

Request Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<anyType xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />

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 'Object'.

Response Information

Resource Description

A hydrated ActionResponse

ActionResponse
NameDescriptionTypeAdditional information
Succeeded

Whether the action request was successfully handled.

boolean

None.

Response

The response to the request.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Succeeded": true,
  "Response": "sample string 2"
}

application/xml, text/xml

Sample:
<ActionResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Succeeded>true</Succeeded>
  <Response>sample string 2</Response>
</ActionResponse>