Let the platform do the work
SugarClubContact+1 (877) 842-7276

set_campaign_merge

Overview

Handles campaign log entry creation for mail-merge activity given a specified campaign.

Available APIs

  • SOAP
  • REST

Definition

set_campaign_merge(session, targets, campaign_id)

Parameters

Name Type Description
session String Session ID returned by a previous call to login.
targets select_fields | Array A string array of IDs identifying the targets used in the merge. The IDs used in this parameter come from the column 'prospect_lists_prospects.id'.
campaign_id String The campaign ID used for the mail merge.

Result

Name Type Description
null void No return value.

Change Log

Version Change
v2 Return type was changed from error_value to void.

Example

PHP

$set_campaign_merge_parameters = array(
    //Session id
    "session" => $session_id,

    //A string array of IDs identifying the targets used in the merge.
    //The IDs used in this parameter come from the column 'prospect_lists_prospects.id'.
    "targets" => array(
        '403787cc-ab19-bec8-3ef4-50bd4896c9b3',
        'c5341c8d-4b0a-2b56-7108-50bd48b91213'
    ),

    //The campaign ID used for the mail merge.
    "campaign_id" => '781d4471-fb48-8dd2-ae62-50bd475950b2'
);

Topics