Campaigns

Public List Campaign Mailboxes

Campaigns endpoint for GET /campaigns/{campaign_id}/mailboxes.

get/campaigns/{campaign_id}/mailboxes

Request

Base URL: https://public.outreach2day.com
URL: https://public.outreach2day.com/campaigns/{campaign_id}/mailboxes
Auth: HTTP bearer

Path parameters

campaign_idstring required

Query parameters

workspaceIdinteger required

Response

Successful Response

idstring nullable

CampaignMailboxId. Stable identifier for this mailbox attachment. Use as {mailbox_id} in PATCH/DELETE /campaigns/{campaign_id}/mailboxes/{mailbox_id} (recommended).

campaignIdstring nullable

mailboxIdstring nullable

Mailbox address (email). Legacy identifier accepted in {mailbox_id} path params.

weightinteger nullable

state'ACTIVE' | 'PAUSED' | 'DISCONNECTED' | 'ERROR' | 'UNKNOWN' nullable

stateRawstring nullable

Original upstream state value before canonicalization. Present when aliased or unknown.

dailyLimitinteger nullable

gapBaseSecondsinteger nullable

gapJitterSecondsinteger nullable

createdAtstring date-time nullable

Example response

[
  {
    "id": "cmb_123",
    "mailboxId": "sender@example.com",
    "stateRaw": "DEGRADED"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.