Skip to main content
PUT
Set Step Sender
A forced sender requires at least the Email Pro plan.
Forces the sender of one step, with the rules of the campaign editor.

Which steps accept a forced sender

Delay, condition and other utility steps have no sender: the endpoint answers 409.

Rules

  • userId must be a team member who owns the account.
  • Without channel.id, the first healthy account of the type is used. An unhealthy account is accepted when you name it. Read its diagnostics with Get Campaign Senders.
  • channel.alias picks an alias of an email account. It needs channel.id.
  • An InMail step needs a sender with LinkedIn Premium.

Effects

  • The sender pool changes as in the campaign editor: a channel type that no other step uses leaves the pool. senderPoolChange lists the channel types that the change enables or disables in the pool.
  • On a running campaign, the pending tasks of the step move to the forced sender.

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

sequenceId
string
required

The unique identifier of the sequence

stepId
string
required

The unique identifier of the step

Body

application/json
userId
string
required

The team member who sends the step

channel
object

Required on an email, LinkedIn, WhatsApp or SMS step. Forbidden on a call, manual, API or phone step.

Response

Success

data
object