Skip to main content
POST
/
EVENTS.CAMPAIGN.CREATED
{
  "campaign": {
    "id": "camp_iRMdcq07g9W4dOSRXuTovupi",
    "name": "Spring Discounts",
    "type": "AUTO_UPDATE",
    "active": true,
    "object": "campaign",
    "voucher": {
      "type": "DISCOUNT_VOUCHER",
      "discount": {
        "type": "PERCENT",
        "effect": "APPLY_TO_ORDER",
        "percent_off": 10,
        "amount_limit": 3000,
        "percent_off_formula": "IF(ORDER_AMOUNT > 150;15;10)"
      },
      "redemption": {
        "quantity": 1
      },
      "start_date": "2024-03-01T00:00:00.000Z",
      "code_config": {
        "length": 3,
        "prefix": "SPRING-2024-",
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "pattern": "###"
      },
      "expiration_date": "2024-03-31T00:00:00.000Z",
      "is_referral_code": false
    },
    "category": "Star Platinum",
    "metadata": {},
    "auto_join": false,
    "join_once": false,
    "protected": false,
    "categories": [
      {
        "id": "cat_0e156dab8f2e43873a",
        "name": "Star Platinum",
        "object": "category",
        "hierarchy": 10,
        "created_at": "2024-01-03T10:03:24.092Z"
      }
    ],
    "created_at": "2024-02-21T10:01:24.102Z",
    "start_date": "2024-03-01T00:00:00.000Z",
    "category_id": "cat_0e156dab8f2e43873a",
    "description": "Spring 2024 discount",
    "campaign_type": "DISCOUNT_COUPONS",
    "vouchers_count": 0,
    "creation_status": "IN_PROGRESS",
    "expiration_date": "2024-03-31T00:00:00.000Z",
    "validity_day_of_week": [
      5,
      6,
      0
    ],
    "vouchers_generation_status": "IN_PROGRESS",
    "use_voucher_metadata_schema": true
  }
}

Response

200 - application/json

Indicates that a campaign has been created.

Event data object schema for campaign.created.

​
campaign
object

Object representing a campaign.

​
created_at
string<date-time>

Timestamp representing the date and time when the campaign was created in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

⌘I