Skip to main content
POST
/
api
/
v1
/
actions
/
{id}
/
execute
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "action_communications": [
    {}
  ],
  "approved_at": "<string>",
  "call_context": {},
  "completed_at": "<string>",
  "created_at": "<string>",
  "error_message": "<string>",
  "executed_at": "<string>",
  "metadata": {
    "appeal_type": "<string>",
    "include_documents": [
      "<string>"
    ]
  },
  "prerequisite_action_ids": [
    "<string>"
  ],
  "prerequisites_check": {
    "satisfied": true,
    "missing_forms": [
      "<string>"
    ],
    "missing_deliveries": [
      "<string>"
    ],
    "missing_confirmations": [
      "<string>"
    ],
    "missing_actions": [
      "<string>"
    ],
    "forms_needed": [
      {}
    ]
  },
  "result": {},
  "retry_count": 123,
  "scheduled_for": "<string>",
  "sequence_order": 123,
  "supported": true,
  "target_denial_ids": [
    "<string>"
  ],
  "target_denials": [
    {
      "id": "<string>",
      "procedure_code": "<string>",
      "procedure_description": "<string>"
    }
  ],
  "target_entity_matched": true,
  "target_name": "<string>",
  "unsupported_reasons": [
    "<string>"
  ],
  "updated_at": "<string>"
}

Path Parameters

​
id
string
required

Body

application/x-www-form-urlencoded

The body is of type object.

Response

OK

​
id
string
required
​
action_communications
object[]
required
​
action_type
enum<string>
required
Available options:
call,
fax,
email,
file_appeal,
request_info,
sign_form,
wait,
request_external_review,
confirm_form_on_file,
renew_authorization,
deliver_form
​
approved_at
string
required
​
call_context
object
required
​
completed_at
string | null
required
​
created_at
string
required
​
error_message
string | null
required
​
executed_at
string | null
required
​
metadata
object
required
​
prerequisite_action_ids
string[]
required
​
prerequisites_check
object
required
​
result
object
required
​
retry_count
integer
required
​
scheduled_for
string | null
required
​
sequence_order
integer
required
​
status
enum<string>
required
Available options:
pending_prereqs,
ready,
pending_approval,
pending_confirmation,
approved,
executing,
completed,
failed,
cancelled
​
supported
boolean
required
​
target_denial_ids
string[]
required
​
target_denials
object[]
required
​
target_entity_matched
boolean
required
​
target_name
string
required
​
target_party
enum<string>
required
Available options:
insurer,
provider,
patient,
pharmacy,
other
​
unsupported_reasons
string[]
required
​
updated_at
string
required