Perform action on a case

Prev Next
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
actionId
stringRequired

ID of the action

caseId
stringRequired

ID of the case

Body parameters

tenantId

string (uuid)
Responses
200

OK

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
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.
sender
string

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

ExampleAdam Smith
400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too many requests. Please retry later