Sequencers

Export mailboxes to sending tools

POST
/v1/sequencer-exports

Puts mailboxes into one or more connected tools: one export per mailbox and connection, each followed to completed with sequencer_export.completed or sequencer_export.failed. A pair already exported is answered under alreadyExported, not duplicated. Only a mailbox that is set up (active) can go; every other one is listed in skipped with why. Nothing is charged.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Header Parameters

Idempotency-Key?string

A value unique to this request, such as a UUID. A retry with the same key within 24 hours returns the first outcome instead of running again.

Length8 <= length <= 200

Request Body

application/json
  1. body
connectionIds*array<string>

1 to 5 connections; each mailbox goes to every one

Items1 <= items <= 5
mailboxIds?array<string>

Up to 1000 mailboxes. Or send mailboxDomainId

Items1 <= items <= 1000
mailboxDomainId?string

Every mailbox on this domain

Response Body

Accepted: each export runs on its own, followed to completed or failed

application/json
  1. response

Accepted: each export runs on its own, followed to completed or failed

created*array<>

New exports, one per mailbox and connection

alreadyExported*array<>

Pairs that already had an export (on its way, done or failed): not duplicated

skipped*array<>

Mailboxes that got no export, each with why

curl -X POST "https://example.com/v1/sequencer-exports" \  -H "Idempotency-Key: 2f1c9a52-7d0e-4a8e-9a53-0c1f6f3f2b11" \  -H "Content-Type: application/json" \  -d '{    "connectionIds": [      "sqn_01K6XJ4Q8ZT3M9R5V2B7WDHNCA"    ]  }'
{  "created": [    {      "id": "sqe_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "connectionId": "sqn_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "connectionName": "Acme Instantly",      "platform": "instantly",      "mailboxId": "mbx_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "mailboxDomainId": "mdm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "email": "jo@northwind-mail.com",      "domain": "northwind-mail.com",      "status": "queued",      "step": "wait_mailbox",      "reason": "api_key_invalid",      "reasonMessage": "string",      "retrying": true,      "lastError": {        "step": "string",        "code": "string",        "message": "string",        "at": "2026-10-30T11:04:31.000Z"      },      "nextRunAt": "2026-10-30T11:04:31.000Z",      "accountId": "string",      "completedAt": "2026-10-30T11:04:31.000Z",      "removedAt": "2026-10-30T11:04:31.000Z",      "createdAt": "2026-10-30T11:04:31.000Z",      "updatedAt": "2026-10-30T11:04:31.000Z"    }  ],  "alreadyExported": [    {      "id": "sqe_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "connectionId": "sqn_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "connectionName": "Acme Instantly",      "platform": "instantly",      "mailboxId": "mbx_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "mailboxDomainId": "mdm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "email": "jo@northwind-mail.com",      "domain": "northwind-mail.com",      "status": "queued",      "step": "wait_mailbox",      "reason": "api_key_invalid",      "reasonMessage": "string",      "retrying": true,      "lastError": {        "step": "string",        "code": "string",        "message": "string",        "at": "2026-10-30T11:04:31.000Z"      },      "nextRunAt": "2026-10-30T11:04:31.000Z",      "accountId": "string",      "completedAt": "2026-10-30T11:04:31.000Z",      "removedAt": "2026-10-30T11:04:31.000Z",      "createdAt": "2026-10-30T11:04:31.000Z",      "updatedAt": "2026-10-30T11:04:31.000Z"    }  ],  "skipped": [    {      "mailboxId": "string",      "email": "string",      "connectionId": "sqn_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "reason": "mailbox_not_found",      "message": "string"    }  ]}