De-escalate
POST /events/deescalate
Overview
The POST /events/deescalate
API can be used to programmatically de-escalate (revoke) a Run that has a status escalated
.
The Open API Spec and and example requests are available here: De-escalate a user.
Request Body
The request body consists of one parameter: run_id
. This can be obtained from the response body of a Request API call.
{
"run_id": "b8d4b0ce-0971-4aec-88e5-971b70fa0066"
}
Request Validation Rules
A de-escalate request will only be accepted if the Run has a status of escalated
. The status of a Run can be retrieved with the Get Run Status API.
Otherwise, you will receive an error response such as:
{
"error": true,
"message": "Cannot de-escalate a run with status 'requested'. Status must be 'escalated'.",
"code": "DeescalateAPI:INVALID_RUN",
"status_code": 400
}
Response Body
The response body will contain an event_id
identifying the de-escalate Event created. This event_id
can be used in the Get Event Status API to view the result of the de-escalate request.
{
"event_id": "778f9f22-f892-4b9f-85cc-b4141de0dcbc",
"request_body": {
"run_id": "b8d4b0ce-0971-4aec-88e5-971b70fa0066"
}
}
For example:
Updated over 1 year ago