Disabled

EVENT: "EVENTS.CAMPAIGN.DISABLED"
HTTP method: POST

The EVENTS.CAMPAIGN.DISABLED event indicates that the campaign is temporarily or permanently inactive. It cannot be utilized during that period.

📘

Webhook documentation

This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Webhook v2024-01-01 page.

Example: campaign.disabled

{
  "campaign": {
    "id": "camp_s2tD4F3yQhGTKuXjKasSNeP6",
    "name": "Promotion Spring 2024",
    "type": "STATIC",
    "active": false,
    "object": "campaign",
    "metadata": {
      "region": "EMEA"
    },
    "auto_join": false,
    "join_once": false,
    "protected": false,
    "categories": [],
    "created_at": "2024-02-21T12:34:04.667Z",
    "updated_at": "2024-02-21T14:15:02.111Z",
    "category_id": "cat_0e156dab8f2e43873a",
    "campaign_type": "PROMOTION",
    "creation_status": "DONE",
    "expiration_date": "2024-02-29T00:00:00.000Z",
    "vouchers_generation_status": "DONE",
    "use_voucher_metadata_schema": false
  }
}
Language
Click Try It! to start a request and see the response here!