Skip to main content
Vindicia Knowledge Center

Campaign.activateCode

Campaign.activateCode

Campaign.activateCode

Activates a Coupon Code. Use this method to activate individual Coupon Codes before they may be used.

Coupon Codes may not be activated if their Campaign is not Active.

Use the validateCode method to activate a Code at the same time it is validated.

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.

code: the Coupon Code to be activated. Because all Coupon Codes are unique, it is sufficient to specify the Code.

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:

  • Code code doesn't represent a CouponCode.
  • Code code can't be activated: error-description.

Example

$camp = new Campaign();

$response = $camp->activateCode(

'promo123', // the campaign code

);

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top