Skip to main content
POST
/
EVENTS.CUSTOMER.SEGMENT.LEFT
{
  "customer": {
    "id": "cust_5P5B8oy1pxM3sTOZ8qDpmkpG",
    "source_id": "a-tst",
    "name": "Alex Test",
    "address": {
      "city": null,
      "state": null,
      "line_1": null,
      "line_2": null,
      "country": null,
      "postal_code": null
    },
    "summary": {
      "redemptions": {
        "total_redeemed": 0,
        "total_failed": 0,
        "total_succeeded": 0,
        "total_rolled_back": 0,
        "total_rollback_failed": 0,
        "total_rollback_succeeded": 0,
        "gift": {
          "redeemed_amount": 0,
          "amount_to_go": 0
        },
        "loyalty_card": {
          "redeemed_points": 0,
          "points_to_go": 0
        }
      },
      "orders": {
        "total_amount": 0,
        "total_count": 0,
        "average_amount": 0,
        "last_order_amount": 0
      }
    },
    "loyalty": {
      "points": 0,
      "referred_customers": 0,
      "campaigns": {}
    },
    "referrals": {
      "total": 0,
      "campaigns": []
    },
    "metadata": {},
    "system_metadata": {},
    "created_at": "2024-02-29T14:04:46.506Z",
    "object": "customer"
  },
  "segment": {
    "id": "seg_n3vVcU5t0m3rs4rEPr3C1oU5",
    "name": "New Customers",
    "object": "segment"
  }
}

Response

200 - application/json

Indicates that a customer has left a segment.

Event data object schema for customer.segment.left

​
customer
object
required

Customer details with details about loyalty and referral programs.

​
segment
object
required

Simplified segment data.

​
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