Create a mailbox history backfill

POST 
/v1/:mailerID/backfill

Creates a one-time mailbox history backfill job for a connected mailbox and enqueues the first slice. The platform imports historical emails (newest-first) and delivers each one to the mailer's configured webhook; the tenant dedupes by Message-Id. Provide at least one of window_start (RFC3339) or count — window_end is optional and defaults to now. Idempotent per mailer: an active job returns 409 with the existing jobId. NOTE: backfill is currently supported ONLY for Google (Gmail) OAuth IMAP mailboxes.

Request

Path Parameters

mailerID stringrequired

Mailer ID

application/json

Body

required

Backfill Payload

count integer

folders

object

inbox boolean

sent boolean

spam boolean

trash boolean
window_end string
window_start string

Responses

202

Backfill accepted

application/json

Schema

Schema

jobId string
success boolean

Example (from schema)

{
  "jobId": "01JC3BBW8S9YGX2VNKG5MD7BTA",
  "success": true
}

400

Bad Request

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

404

Mailer not found

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

409

Active backfill already exists

application/json

Schema

Schema

error string
jobId string
success boolean

Example (from schema)

{
  "error": "string",
  "jobId": "01JC3BBW8S9YGX2VNKG5MD7BTA",
  "success": false
}

Loading...