MailMoo
ToolsLeads

mailmoo_leads_bulk_update

Act on many leads at once

Pause or resume outreach, move to a pipeline stage, put on another sender, or set a field's value, for a group of leads: one campaign's leads (filtered or all), leads across the CRM, or specific lead ids. Up to 5,000 at a time. Without confirm it changes nothing and returns what the selection contains (counts by campaign, stage, sequence status and sender; for set_field, how many records change and their current values). Show that, then call again with confirm: true. change_sender needs campaign and sender, and with restartSequence also starts the leads again from the first step. move_stage to a lost stage needs closeReason. set_field needs field, value and fieldLevel: 'campaign' edits the column in each lead's campaign, which that campaign's messages read (e.g. a campaign column 'Interested' to 'false'); 'person' edits the person's own field, shared by all their campaigns; 'company' edits the field on each lead's company. Pick the level from what the user means: a campaign column, or a fact about the person or company. Social profile, email, phone, names and website can be changed, but they decide where outreach goes: the preview's warnings say when a value does not look like the field's format. Show every warning to the user and get their go-ahead before confirming. One social profile, company page or website cannot be set on several people or companies at the person or company level. To put leads into another campaign, use leads_enroll.

Effect: Write. See Effects.

Permissions: Read CRM, Read campaigns, Read leads, Update pipeline status, Write campaigns.

Parameters

ParameterTypeRequiredDescription
actionpause, resume, move_stage, change_sender, set_fieldYesWhat to do to the selected leads.
campaignstringNoAct on this campaign's leads, by name or id. Omit to select across the whole CRM (not allowed for change_sender).
leadIdsarray of stringNoExactly these leads. Overrides the filters.
querystringNoSearch box text: name, email, company, or profile URL.
companystringNoOnly leads whose company name contains this text.
companiesarray of stringNoLeads at any of these companies, by name (contains). Each name counts toward the filter limit. Use instead of company.
columnEqualsarray of objectNoOnly leads whose campaign column holds this value, e.g. [{ column: 'Interested', value: 'true' }]. Needs campaign. Column names from campaign_get_context.
jobTitlestringNoOnly leads whose job title contains this text.
industrystringNoOnly leads whose industry contains this text.
sequenceStatusIN_PROGRESS, COMPLETED, PAUSED, FAILEDNoOnly leads whose sequence is in this state: IN_PROGRESS, COMPLETED, PAUSED, or FAILED.
pipelineStagestringNoOnly leads in this pipeline stage: a category such as IN_CONVERSATION, or a stage name.
excludePipelineStagestringNoLeave out leads in this pipeline stage, e.g. MEETING_BOOKED to skip anyone who already booked.
connectionAcceptedbooleanNotrue: only leads who accepted the connection request. false: only leads who did not. For pending, not accepted or never requested, use connection.
connectionaccepted, pending, declined, never_requestedNoWhere the connection request stands with the lead's sender. accepted: connected. pending: sent, still waiting. declined: sent, and the wait for acceptance ran out without a connection (ignored requests count too). never_requested: no request sent yet. Use instead of connectionAccepted, not with it.
stagestringNomove_stage: the stage to move to, by name.
closeReasonNOT_ICP, WRONG_PERSON, BAD_DATA, NO_ACCESS, UNRESPONSIVE, WENT_DARK, NOT_INTERESTED, NO_BUDGET, LOST_COMPETITOR, CHOSE_STATUS_QUO, COMPANY_CHANGE, LEFT_COMPANY, DO_NOT_CONTACT, OTHERNomove_stage to a lost stage: why.
followUpAtstringNomove_stage to an on-hold stage: when to revisit, ISO 8601.
senderstringNochange_sender: the campaign's sender to move them to, by name or id.
restartSequencebooleanNochange_sender: also restart from the first step. Default false keeps their place.
fieldLevelcampaign, person, companyNoset_field: the campaign's column, the person's field, or the company's field.
fieldstringNoset_field: the column or field name, e.g. 'Interested'.
valuestring or nullNoset_field: the new value, or null to clear it.
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