MailMoo
ToolsCampaigns

mailmoo_campaign_update_senders

Change a campaign's senders

Changes which senders an existing campaign uses: add some, remove some, or both. Use for 'take X off this campaign', 'remove sender X from Y', 'add X to Y' or 'swap X for Z'. Senders and campaigns by name or id. Removing a sender unassigns the leads they held so the remaining senders pick them up, except leads already in conversation with that sender: another sender cannot carry on that thread, so they wait until moved with leads_bulk_update (change_sender). A campaign always keeps at least one sender, so for a swap pass add and remove together. Works while the campaign is running, and an added sender starts sending at once. Without confirm it changes nothing and returns who would be added and removed, how many leads are affected, and any sender who cannot send (disconnected, or no social account). Show that to the user, then call again with confirm: true. It never starts or pauses the campaign: that is campaign_set_state.

Effect: Write. See Effects.

Permissions: Read campaigns, Write campaigns.

Parameters

ParameterTypeRequiredDescription
campaignstringYesThe campaign, by name or id.
addarray of stringNoSenders to add, by name or id, from senders_list.
removearray of stringNoSenders to take off this campaign, by name or id.
confirmbooleanNoLeave out first: the call then changes nothing and returns what would happen. Show that to the user, and call again with confirm: true once they agree.

On this page