Skip to main content
POST
/
EVENTS.DISTRIBUTION.MANUAL_DISTRIBUTION_SCHEDULE
{
  "distribution": {
    "id": "distr_3oun3MaJpcqzxYmHN0PReck1k8",
    "created_at": "2024-03-13T13:37:39.250Z",
    "updated_at": null,
    "status": "TO SEND",
    "consents": {
      "disabled": true
    },
    "set_live_at": null,
    "distribution_channels": [
      "webhook"
    ]
  },
  "campaign": {
    "id": "camp_iRMdcq07g9W4dOSRXuTovupi",
    "name": "Spring Discounts",
    "campaign_type": "DISCOUNT_COUPONS",
    "type": "AUTO_UPDATE",
    "is_referral_code": false,
    "voucher": {
      "type": "DISCOUNT_VOUCHER",
      "discount": {
        "type": "PERCENT",
        "amount_limit": 3000,
        "percent_off": 10,
        "percent_off_formula": "IF(ORDER_AMOUNT > 150;15;10)",
        "units": null,
        "effect": "APPLY_TO_ORDER"
      },
      "gift": null,
      "loyalty_card": null,
      "redemption": {
        "quantity": 1,
        "redeemed_quantity": 0
      },
      "code_config": {
        "pattern": "###",
        "length": 3,
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "prefix": "SPRING-2024-",
        "postfix": ""
      }
    },
    "auto_join": false,
    "join_once": false,
    "active": true,
    "category_id": "cat_0e156dab8f2e43873a",
    "category": null,
    "metadata": {},
    "start_date": null,
    "expiration_date": null,
    "description": "Spring 2024 big campaign",
    "created_at": "2024-02-21T10:01:24.102Z",
    "updated_at": "2024-02-23T11:43:11.539Z",
    "object": "campaign"
  },
  "voucher": {
    "id": "v_ae1exRSLU9I4ncJjY5heHvVTE189Y3NB",
    "code": "SPRING-2024-osO",
    "discount": {
      "type": "PERCENT",
      "amount_limit": 3000,
      "percent_off": 10,
      "effect": "APPLY_TO_ORDER",
      "percent_off_formula": "IF(ORDER_AMOUNT > 150;15;10)"
    },
    "type": "DISCOUNT_VOUCHER",
    "campaign": "Spring Discounts",
    "campaign_id": "camp_iRMdcq07g9W4dOSRXuTovupi",
    "is_referral_code": false,
    "holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "category_id": "cat_0e156dab8f2e43873a",
    "active": true,
    "created_at": "2024-03-13T13:45:41.161Z",
    "updated_at": "2024-03-13T13:46:48.140Z",
    "redemption": {
      "quantity": 1,
      "redeemed_quantity": 0
    },
    "start_date": null,
    "expiration_date": null,
    "metadata": {},
    "object": "voucher"
  },
  "customer": {
    "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "name": "Jack Webhook",
    "email": null,
    "source_id": "jck-wbhk",
    "metadata": {
      "region": "EMEA",
      "sign-up": "true"
    },
    "object": "customer"
  },
  "publication": {
    "id": "pub_eB4okLT7vHrFoajHJGeoKir285dBxY1z",
    "object": "publication",
    "created_at": "2024-03-13T13:46:48.136Z",
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "tracking_id": "jck-wbhk",
    "metadata": {
      "source_type": "distribution",
      "source_id": "distr_3oun3MaJpcqzxYmHN0PReck1k8",
      "distribution_id": "distr_3oun3MaJpcqzxYmHN0PReck1k8"
    },
    "channel": "Dashboard",
    "source_id": null,
    "result": "SUCCESS",
    "customer": {
      "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "source_id": "jck-wbhk",
      "name": "Jack Webhook",
      "address": null,
      "summary": null,
      "loyalty": null,
      "referrals": null,
      "metadata": {
        "region": "EMEA",
        "sign-up": "true"
      },
      "object": "customer"
    },
    "vouchers_id": [
      "v_ae1exRSLU9I4ncJjY5heHvVTE189Y3NB"
    ]
  }
}

Response

200 - application/json

Indicates that a manual distribution has been scheduled.

Indicates that distribution has been scheduled.

​
distribution
object
required

Simple distribution data.

​
customer
object

Details about the customer related to the distribution with a promotion or send voucher purpose.

​
campaign
object

Details about the campaign related to the distribution with a promotion or send voucher purpose.

​
voucher
object

Details about the voucher related to the distribution with a send voucher purpose.

​
publication
object

Details about the publication related to the distribution with a send voucher purpose.

​
promotion_tier
object

Details about the promotion tier related to the distribution with a promotion purpose.

⌘I