Retract a pending submission

post

https://app.ekas.io/v1/registrations/{id}/retract

Withdraw the submission before a decision, where the upstream provider supports retraction. Returns 409 when the provider does not support withdrawal or a decision has already landed. Ends in terminal retracted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The registration, now retracted.

400Invalid request (malformed body, missing/invalid parameter).

401Missing or invalid API key.

403API key lacks a required scope (named in error.param) or test-only endpoint called with a live key.

404No such resource (or it belongs to another mode/subaccount).

409Invalid state transition, in-flight registration conflict, or idempotency key reuse with a different body.

429Rate limit exceeded; see Retry-After. RateLimit-* headers appear on every response, not only 429s.

502Upstream provider (CPaaS/TCR/Google/carrier) failure; details in error.message.