Campaigns

Attach sender emails to a campaign

Attaches connected sender emails from your workspace to a campaign. A running campaign only sends through the sender emails attached to it, so this call decides which mailboxes the campaign uses. Idempotent: already-attached senders are left untouched and only missing ones are added. The call is refused whole when any requested sender email is not yours (404) or not connected (409). Attaching to a running campaign triggers a reschedule so the new senders are picked up.

post/campaigns/{id}/sender-emails

Request

  • Base URL: https://api.emailchaser.com/r
  • URL: https://api.emailchaser.com/r/campaigns/{id}/sender-emails
  • Auth: HTTP bearer

Path parameters

idinteger required

Campaign ID

Request body

senderEmailIdsinteger[] required

SenderEmailIDs are the sender emails to attach. Every ID must be a connected sender email in your workspace; the call is refused whole if any is not.

Example request

{
  "senderEmailIds": [
    1,
    2
  ]
}

Response

Sender emails attached

alreadyAttachedinteger[]

AlreadyAttached lists the requested sender emails that were attached before this call (the call is idempotent: they are left untouched).

attachedinteger[]

Attached lists the sender emails newly attached by this call.

campaignIdinteger
messagestring
senderEmailIdsinteger[]

SenderEmailIDs lists every sender email attached to the campaign after this call.

Example response

{
  "alreadyAttached": [
    3
  ],
  "attached": [
    1,
    2
  ],
  "campaignId": 10,
  "message": "sender emails attached successfully",
  "senderEmailIds": [
    1,
    2,
    3
  ]
}

Changes

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