MNB API v1.0 CampaignUpdate Method

CampaignUpdate < Return to Method List

boolean CampaignUpdate(integer $id, struct $details)

Update an existing campaign.

Parameters

integer id

The campaign id to update.

struct details

Data to update the campaign with. To update data, include the appropriate key/value pair:

string name

The new internal name for the campaign.

string subject

The new subject line.

struct from

Data to use in the From field: "John Doe" <email@domain.tld>. Requires:

string name	The name to use.
string email	The email address to use.

struct reply

Data to use in the Reply-To field: "John Doe" <email@domain.tld>. Requires:

string name	The name to use.
string email	The email address to use.

string html

The HTML content for the campaign.

string text

OPTIONAL. The text content for the campaign. Use an empty string and we will generate the content from your HTML version.

boolean link_tracking

OPTIONAL. Enable link tracking for this campaign. Default = TRUE.

boolean gat

OPTIONAL. Enable Google Analytics Tracking for this campaign. Requires $link_tracking. Default = FALSE.

Return Value

boolean	Returns TRUE on success, or an error structure.