Skip to navigation
APIPay Ops endpointsBoardingApplications

Withdraw an application

Beta
View as MarkdownOpen in Claude
Withdraws a boarding application. The response returns the application's new status and the actions now allowed on it.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

requestsReferencestringRequired
The application reference.

Request

This endpoint expects an object.
reasonstringOptional
An optional reason for the withdrawal, recorded in the status history.

Response

The application was withdrawn.
successboolean
Whether the request succeeded.
messagestring or null

A human-readable result message.

traceIdstring or null
The trace identifier for the request, useful for support.
dataobject or null

The lifecycle-action result.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error