SysDeletePromotion

Deletes the specified promotion from the server.

Service	Operation
promotions	SYS_DELETE_PROMOTION

info

Note: SysDeletePromotion will also delete archived promotions, not just active ones. Use this operation carefully if you intend to preserve archived promotion history.

Method Parameters

Parameter	Description
promotionId	ID uniquely identifying the promotion to update. Note: If promotionId is included in the promotionJson, it is ignored. The promotionId provided as a direct parameter takes priority.
version	Version of the promotion to update. Can bypass version check by passing in -1.

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Obj-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Roblox

// N/A

GDScript

N/A

Cloud Code

var promotionId = 1;
var version = 2;
var promotionsProxy = bridge.getPromotionsServiceProxy();

var postResult = promotionsProxy.sysDeletePromotion(promotionId, version);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "promotions",
    "operation": "SYS_DELETE_PROMOTION",
    "data": {
    "promotionId": 1,
    "version": 1
  }
}

JSON Response

{
    "data": null,
    "status": 200
}