Perform an action on a case

  • 1 minute(s) read
Prev
Put
/v1/workflows/cases/{caseId}/actions/{actionId}

Supported file types: application/pdf, text/csv, text/plain, application/vnd.ms-powerpoint, application/vnd.ms-excel, application/msword, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.oasis.opendocument.text, application/vnd.oasis.opendocument.presentation, application/vnd.oasis.opendocument.spreadsheet, image/jpeg, image/png, image/avif, image/jp2, image/jpx, image/jpm

PUT executes a specific action against a transaction case. Currently, only the `information-received` action is supported.

When the Request for Information workflow is triggered in a transaction case, and the operator has confirmed the required information, you can call this API to automatically transition the case to the "Information received" investigation status.

If an attachment is included in the request,  a note will also be added automatically to the corresponding transaction case (See above the supported file types)


Security
API Key: API_KEY
Header parameter nameapi-key
Path parameters
caseId
stringRequired

ID of the case

Examplea46d07c7-c297-4364-bed9-24c0b417297c
actionId
stringRequired

ID of the action

Exampleinformation-received
Query parameters
attachments

List of files to upload

Body parameters
Expand All
object
actionRequest
object (ActionRequest) Required
actionTriggeredAt
string (date-time) Required

The time the action is triggered at the tenant side in UTC time zone.

Example2024-11-16T11:38:47.812Z
sender
string Required

The person who triggered the action. The information is used for audit purposes.

ExampleAdam Smith
note
string

The note provided by the sender.

ExampleThis is a note provided by the sender with any information required to continue investigating this specific case or group of cases.
attachments
Array of string Required
string (binary)
Responses
202

The request was accepted for asynchronous processing

object
actionTriggeredAt
string (date-time)

The time the action is triggered at the tenant side in UTC time zone.

Example2024-11-16T11:38:47.812Z
sender
string

The person who triggered the action. The information is used for audit purposes.

ExampleAdam Smith
note
string

The note provided by the sender.

ExampleThis is a note provided by the sender with any information required to continue investigating this specific case or group of cases.
400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too many requests. Please retry later