Move to campaign

Move leads from one campaign to another.

When to use. Reassign leads from a source campaign to a destination campaign in one request, optionally carrying over their existing campaign-lead data.

Parameters.

  • id (array of integers, required): the lead IDs to move.
  • source_campaign_id (integer, required): the campaign the leads are moving from.
  • destination_campaign_id (integer, required): the campaign the leads are moving to.
  • with_preserve_data (boolean): when true, the campaign-lead data is carried over to the destination campaign.

Returns. { "campaignLeads": [ ... ], "messages": [ ... ] }. campaignLeads holds the moved records in the destination campaign, and messages lists any leads that were skipped, for example a lead that was not found or was not assigned to the source campaign.

Example.

{ "id": [1, 123], "source_campaign_id": 1, "destination_campaign_id": 2, "with_preserve_data": true }
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
id
array of integers
required

Lead IDs to move.

id*
integer
required

Source campaign ID.

integer
required

Destination campaign ID.

boolean

Preserve campaign-lead data when moving.

Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json