customer deleted

EVENT

customer.deleted

Published when a customer is deleted. For more information, see Use Customer Webhooks.

The customer object in the event notification does not include the following fields: group_ids and segment_ids.

Permissions:CUSTOMERS_READ

Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the seller associated with the event.

Link to section

type

string

The type of event. For this object, the value is customer.deleted.

Link to section

event_id

string

The unique ID of the event, which is used for idempotency support.

Link to section

created_at

string

Read only The timestamp of when the event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

data

The data associated with the event.

Link to section

Examples

All versions ->

Response JSON

{
  "merchant_id": "G7MMEBVW021Q4",
  "type": "customer.deleted",
  "event_id": "8e84fec8-f04b-46f0-b66d-dbb8b59590fa",
  "created_at": "2022-11-09T21:26:50Z",
  "data": {
    "type": "customer",
    "id": "QPTXM8PQNX3Q726ZYHPMNP46XC",
    "deleted": true,
    "object": {
      "customer": {
        "address": {
          "address_line_1": "1018 1st Street",
          "administrative_district_level_1": "NY",
          "locality": "Brooklyn",
          "postal_code": "11215"
        },
        "birthday": "1962-03-04",
        "creation_source": "IMPORT",
        "email_address": "[email protected]",
        "family_name": "Smiley",
        "given_name": "Jenkins",
        "id": "QPTXM8PQNX3Q726ZYHPMNP46XC",
        "phone_number": "+12126668929",
        "preferences": {
          "email_unsubscribed": false
        },
        "version": 3
      }
    }
  }
}