Campaigns

Public Update Campaign Mailbox

Campaigns endpoint for PATCH /campaigns/{campaign_id}/mailboxes/{mailbox_id}.

patch/campaigns/{campaign_id}/mailboxes/{mailbox_id}

Request

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

Path parameters

campaign_idstring required
mailbox_idstring required

Mailbox identifier. Use campaignMailboxId from CampaignMailboxOut.id (recommended) or mailbox email address (legacy). On an EVA Next workspace the campaignMailboxId is the native mailbox UUID; both it and the address name the same attachment.

Example:cmb_123

Query parameters

workspaceIdinteger required

Request body

weightinteger nullable
dailyLimitinteger nullable
gapBaseSecondsinteger nullable
gapJitterSecondsinteger nullable
statestring nullable

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 2 revisions of this API.