Skip to main content
PUT
Replace Campaign Senders
The sender pool requires at least the Email Pro plan.
To pin the sender of one step, outside the pool, see Set Step Sender in the Sequences group.
Replaces the pool with the senders of the body. Each entry follows the rules of Add Campaign Senders.
A sender or a channel that is not in the body leaves the pool. To add one sender, use Add Campaign Senders. An empty list ({ "senders": [] }) clears the pool.

Effects on the leads

  • The leads not contacted yet get a sender of the new pool at their next step.
  • The contacted leads keep their sender. When their sender or channel leaves the pool, their next steps stop with a “Send user is missing” error, until the sender comes back in the pool.
  • impact.contactedLeads gives the number of these leads. It is present when the change removes a sender or a channel.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

campaignId
string
required

The unique identifier of the campaign

Body

application/json
senders
object[]
required

Response

Success

data
object

The sender pool of a campaign, as the campaign editor shows it.

impact
object

Present when the change removes a sender or a channel.