Cancel a history backfill

DELETE

/v1/grants/{id}/backfill

curl --request DELETE \
  --url https://api.inboxcnx.com/v1/grants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/backfill \
  --header 'Authorization: Bearer <token>'

Cancels the grant’s running history backfill. Mail already handed to processing is still delivered. Subscribed endpoints receive grant.backfill_completed with status: "cancelled". A new backfill over the same range delivers only what is missing.

Requires the write:connections scope.

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string format: uuid

Responses

204

Cancelled

403

The credential lacks the write:connections scope

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

No running history backfill for this grant

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}