v1
latestOpenAPI 3.0.22026-07-144652931.4 MBCancel responder requests for an incident
Cancel pending responder requests for the specified incident.
This endpoint allows you to cancel responder requests for specified targets that are in a pending state. Only responders who have not yet joined or declined can be cancelled. This endpoint requires the account to have access to the responder requests feature.
Account Ability Requirement: The account must have the coordinated_responding ability. Returns 402 Payment Required if the ability is missing. You can use the List Abilities API to check account abilities.
State Constraints: Only responders in the pending state can be cancelled. Responders who have already joined or declined are not affected (the result will indicate their current state).
User vs Escalation Policy Behavior:
- Users: Direct cancellation, updates state to user_cancelled, stops notifications
- Escalation Policies: Stops the escalation process, updates state of all pending users from that escalation policy to user_cancelled and stops notifications
Result Values:
- cancelled: Successfully cancelled
- joined: User already joined (not cancelled)
- declined: User already declined (not cancelled)
- not_found: Target not found or not part of any responder request
Scoped OAuth requires: incidents.write
Path parameters
The ID of the resource.
Headers
The Accept header is used as a versioning header.
Request body
Response
The result of cancelling responder requests for the given incident.