Campaign.deactivateCampaign

Sets the status of an Active or Pending Campaign to Inactive. This method fails silently if the Campaign is already Inactive.

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 deactivated. Identify this object with its VID or campaignId.

Output

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

Returns

In addition to those listed in The Return Object, this call returns:

Return Code	Return String
`400`	One of the following: - `Tried to deactivateCampaign without doing createCampaign first.` - `Current state of <state> is an invalid state for Campaign deactivation.` - `Failed to update SOAP object in DB.` - `Failed to obtain SOAP object from DB.`

Example

$camp = new Campaign();
   $camp->setCampaignId('camp132');
   $response = $camp->deactivateCampaign();
   // check $response

Parent topic:Campaign Methods

Home

Guides

APIs

Input

Output

Returns

Example

​Input

​Output

​Returns

​Example

Input

Output

Returns

Example