Campaigns

Public Add Campaign Mailbox

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

post/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

Headers

Idempotency-Keystring nullable

Request body

mailboxAddressstring nullable

Mailbox email address to attach. Preferred identifier.

mailboxIdstring nullable

Deprecated legacy alias for mailboxAddress (must be an email).

workspaceMailboxIdinteger nullable

Numeric mailbox id returned by GET /mailboxes. Resolved to mailbox address within the workspace.

weightinteger nullable
dailyLimitinteger nullable
gapBaseSecondsinteger nullable
gapJitterSecondsinteger nullable
statestring nullable

Campaign mailbox state (provider-specific accepted values).

Example request

{
  "dailyLimit": 25,
  "gapBaseSeconds": 300,
  "gapJitterSeconds": 120,
  "mailboxAddress": "sender@example.com",
  "state": "ACTIVE",
  "weight": 2
}

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.