Skip to main content
POST
Withdraw an action request

Authorizations

Authorization
string
header
required

Your secret server API key (bs_dev_… or bs_production_…) with Gates API access: the gates:write scope, granted in the Console under Settings → Developer Tools → API Keys. Without it every Gates API call answers gates_scope_required. The organization and environment always come from the key. Site keys are refused.

Body

application/json
request_id
string<uuid>
required

The request_id you sent.

agent
string
required

The agent you sent it through.

Required string length: 1 - 100
reason
string

For your own audit trail. Never shown to the person.

Maximum string length: 200

Response

Withdrawn, or the request as it stands when it was no longer waiting. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: invalid_key (401), gates_scope_required (403), org_not_found (404), request_not_found (404), internal (500).

data
object
required