Skip to main content
Vindicia Knowledge Center

Campaign.activateCampaign

Campaign.activateCampaign

Campaign.activateCampaign

Sets the state of an Inactive or Pending Campaign to Active.

This method will fail if CouponCodes have been created, but not yet retrieved.

This method fails silently if the Campaign is already Active. Activating a Campaign from Pending sets the offer date to the current date.

Input

srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call.

Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response.

campaign: the Campaign object to be activated. Identify this object with its VID or campaignId.

forcePending: a Boolean flag which, if set to true, allows the campaign to be activated, even from the Pending state. If this flag is false or omitted, the Campaign must be in the Inactive state to be activated.

Output

return: an object of type Return that indicates the success or failure of the call.

Returns

In addition to those listed in Standard Return Codes, this call returns:

Return Code

Return String

400

One of the following:

  • Failed to update SOAP object in DB.
  • Current state of <state> is an invalid state for Campaign activation.
  • Failed to obtain SOAP object from DB.
  • Tried to activate Campaign without doing createCampaign first.
  • Can't activate campaign.

Example

$camp = new Campaign();

$camp->setCampaignId('camp132');
[$response = $camp->activateCampaign(false);

// false is for the forcePending parameter

// check $response

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top