Perform an action on an existing case.
This endpoint allows you to:
- Add comments to a case
- Attach supporting documents with comment action
- Submit an override request for a case
- Accept, refuse, or cancel an override request
- Close a case
- Record a callback phone and trigger its phone analysis
Each action will create a permanent record in the case's action log
and may change the case's status.
Required permissions:
cases_write
Action Type Permissions:
comment: Available to contributors and reviewersaccept: Available to reviewers only (not the override creator)refuse: Available to reviewers only (not the override creator)cancel: Available only to the override creatortrigger_phone_analysis: Available to users with the pair role (Company Account Audit case) or the quarantine check write role (Company Account Check case)
Important constraints:
- The cases feature must be enabled for your account
- Actions can only be performed on cases in appropriate states
- Users must have proper roles to perform specific actions
Trigger phone analysis:
The trigger_phone_analysis action records the callback phone number and its source on the case,
and starts the phone analysis of that number, in one call. Read the result with
GET /api/v1/cases/{case_id}/phone_analyses, or wait for the complete_phone_analysis case action.
It needs the phone analysis feature on your account, and a callback step on the case.
The callback step is part of the case's investigation checklist, which is set once, when the case is created:
- Only cases whose evaluation was
unevaluatedwhen the case was created get a callback step.
Cases created from any other evaluation state (unfavorable,anomaly, ...) never have one. - Your workspace can switch the callback step off in its
unevaluatedchecklist settings.
Cases created while it is off have no callback step. - Changing the checklist settings does not add or remove the step on existing cases.
On a case without a callback step, the action returns 422 with the callback_step_missing code,
and records nothing.
The action also returns 422 when:
phoneis not in E.164 format (invalid_phone)sourceisotherandsource_detailsis missing (blank)- the case is closed (
case_closed) or its callback step is completed (callback_step_completed) - the case already has a pending or successful phone analysis (
analysis_limit_reached).
After a failed analysis, you can trigger a new one, with a new phone number if needed. - a pending or successful analysis exists and
phoneis a different number (callback_phone_locked)
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
