Skip to main content
Vindicia Knowledge Center

Campaign Methods

Campaign Methods

Campaign Methods

The following table summarizes the methods for the Campaign object.

 

Method

Description

Campaign.activateCampaign

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

Campaign.activateCode

Activates a CouponCode.

Campaign.cancelCampaign

Cancels a Campaign and all of its existing promotionCodes or couponCodes.

Campaign.cloneCampaign

Vindicia best practices recommendation is to use the CashBox GUI interface, rather than the API, to clone a Campaign.

Campaign.createCampaign

Vindicia best practices recommendation is to use the CashBox GUI interface, rather than the API, to create new Campaigns.

Campaign.deactivateCampaign

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

Campaign.fetchAllCampaigns

Returns an array of Campaign objects, filtered by CampaignState, if specified.

Campaign.fetchByCampaignId

Loads a Campaign by your Campaign ID.

Campaign.fetchByVid

Loads a Campaign by its VID.

Campaign.generateCouponCodes

Vindicia best practices recommendation is to use the CashBox GUI interface, rather than the API, to generate Coupon Codes.

Campaign.markAllCouponsUsed

Vindicia best practices recommendation is to use the CashBox GUI interface, rather than the API, to mark all Coupons Used.

Campaign.retrieveCouponCodes

Fetches previously generated CouponCodes.

Campaign.updateCampaign

Vindicia best practices recommendation is to use the CashBox GUI interface, rather than the API, to update a Campaign.

Campaign.validateCode

Checks if a Coupon or Promotion may be used.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top