Campaign-Leads

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 }
put/{sub_domain}/api/campaign-leads/move-to-campaign

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/campaign-leads/move-to-campaign
  • Auth
    API key in header Authorization

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

source_campaign_idinteger required

Source campaign ID.

with_preserve_databoolean nullable

Preserve campaign-lead data when moving.

destination_campaign_idinteger required

Destination campaign ID.

Response

Successful Response

messagesstring[] nullable

Per-lead informational messages (e.g. lead not found / not assigned to source).

Changes

No recorded changes to this operation across all 1 revision of this API.