Campaigns

Public Add Campaign Mailboxes Batch

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

post/campaigns/{campaign_id}/mailboxes/batch

Request

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

Path parameters

campaign_idstring required

Query parameters

workspaceIdinteger required

Headers

Idempotency-Keystring nullable

Request body

mailboxIdsstring[]

Mailbox email addresses to attach. Duplicates are deduplicated case-insensitively.

weightinteger nullable
dailyLimitinteger nullable
gapBaseSecondsinteger nullable
gapJitterSecondsinteger nullable
statestring nullable

Campaign mailbox state (provider-specific accepted values).

Example request

{
  "mailboxIds": [
    "sender-a@example.com",
    "sender-b@example.com"
  ]
}

Response

Successful Response

statusstring nullable
workspaceIdinteger nullable
campaignIdstring nullable
requestedCountinteger nullable
processedCountinteger nullable
batchSizeinteger nullable
addedCountinteger nullable
skippedCountinteger nullable
invalidCountinteger nullable
failedCountinteger nullable
addedMailboxIdsstring[]
skippedMailboxIdsstring[]
invalidMailboxIdsstring[]
failedMailboxIdsstring[]

Changes

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