SysCreatePromotion

Creates a new promotion. The full promotion JSON (minus the promotionId) should be provided. The full promotion JSON, including the created promotionId, will be returned as a result (similar to SysReadPromotion()).

Service	Operation
promotions	SYS_CREATE_PROMOTION

Method Parameters

Parameter	Description
promotionJson	The full promotion JSON (minus the promotionId). Supports two promotion types: SCHEDULED (requires startAt and endAt epoch timestamps) and AUTOMATED (requires duration in hours, and supports isRetriggerable, maxRetriggers, and maxPurchases).

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

Objective-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

Cloud Code

// Example 1: SCHEDULED type
var promotionJson = {
    "name": "Independence Day Sale",
    "type": "SCHEDULED",
    "startAt": 1593781259911,
    "endAt": 1594126859911,
    "message": {
        "en": "Happy 4th of July!"
    },
    "enabled": false,
    "segments": [],
    "prices": [
        {
            "itemId": "coinbundle10",
            "priceId": 0
        }
    ],
    "notifications": [
        {
            "trigger" : "ACTIVATED",
            "notificationTemplateId" : 1
        }
    ],
    "customJson": {
      "key": "value"
    }
  };
var promotionsProxy = bridge.getPromotionsServiceProxy();

var postResult = promotionsProxy.sysCreatePromotion(promotionJson);
if (postResult.status == 200) {
    // Success!
}

// Example 2: AUTOMATED type
var promotionJson = {
    "type": "AUTOMATED",
    "name": "Automated Promotion Example",
    "message": {
        "en": "This is a promotion with promotional product prices, items pricing info and custom json."
    },
    "enabled": false,
    "segments": [
        30
    ],
    "prices": [
        {
            "itemId": "gems50",
            "priceId": 2
        },
        {
            "itemId": "rubies50",
            "priceId": 3
        }
    ],
    "items": {
        "sword100": {
            "defId": "sword100",
            "buyPrice": {
                "coins": 50
            }
        },
        "wand100": {
            "defId": "wand100",
            "buyPrice": {
                "coins": 50
            }
        }
    },
    "notifications": [],
    "duration": 72,
    "customJson": {
        "bonus": 2
    },
    "isRetriggerable": true,
    "maxRetriggers": 10,
    "maxPurchases": 50
  };
var promotionsProxy = bridge.getPromotionsServiceProxy();

var postResult = promotionsProxy.sysCreatePromotion(promotionJson);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "promotions",
    "operation": "SYS_CREATE_PROMOTION",
    "data": {
    "promotionJson": {
      "name": "Independence Day Sale",
      "type": "SCHEDULED",
      "startAt": 1593781259911,
      "endAt": 1594126859911,
      "message": {
          "en": "Happy 4th of July!"
      },
      "enabled": false,
      "segments": [],
      "prices": [
          {
              "itemId": "coinbundle10",
              "priceId": 0
          }
      ],
      "notifications": [
          {
              "trigger" : "ACTIVATED",
              "notificationTemplateId" : 1
          }
      ],
      "customJson": {
        "key": "value"
      }
    }
  }
}

JSON Response

{
    "data": {
        "gameId": "23783",
        "promotionId": 3,
        "type": "SCHEDULED",
        "name": "Independence Day Sale",
        "message": {
            "en": "Happy 4th of July!"
        },
        "enabled": false,
        "segments": [],
        "prices": [
            {
                "itemId": "coinbundle10",
                "priceId": 0
            }
        ],
        "notifications": [
            {
                "trigger": "ACTIVATED",
                "notificationTemplateId": 1
            }
        ],
        "customJson": {
            "key": "value"
        },
        "startAt": 1593781259911,
        "endAt": 1594126859911,
        "createdAt": 1592544049481,
        "updatedAt": 1592544049481,
        "version": 1
    },
    "status": 200
}