Skip to main content
DELETE
Cancel Company Export

Credits and plans

PAYG is Pay-as-you-go. AYCE is All-you-can-eat.

When to use this endpoint

Stop a company export that is queued or writing rows. Cancellation adds no charge, and unfinished work releases its reservation when it ends.

Example

Set REVENUEBASE_EXPORT_ID to the exportId returned by Start Export. Use a job created by this API key’s account. Set REVENUEBASE_API_KEY to your API key.

Read the status

Cancellation requests are idempotent. A finished export returns its existing terminal status. A completed export is not refunded; wait for an unfinished cancellation to reach a terminal state.

Errors and next steps

A missing export or one you do not own returns 404. Use the identifier from the start response. Read status until the job ends.

Authorizations

X-Key
string
header
required

Path Parameters

export_id
string
required

Response

Successful Response

The response is of type Response Cancel Company Export V1 Company Exports Export Id Delete · object.