All Versions

Customer custom attribute visible deleted

EVENT customer.custom_attribute.visible.deleted

Published when a customer custom attribute that is visible to the subscribing application is deleted. A notification is sent when:

Your application deletes a custom attribute owned by your application, regardless of the visibility setting.
Any application deletes a custom attribute whose visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

Custom attributes set to VISIBILITY_READ_WRITE_VALUES can be deleted by any application, but those set to VISIBILITY_READ_ONLY or VISIBILITY_HIDDEN can only be deleted by the owner. Custom attributes are owned by the application that created the corresponding custom attribute definition.

Permissions

CUSTOMERS_READ

Event payload

Example code

Name	Description
`merchant_id string`	The ID of the seller associated with the event that triggered the event notification.
`type string`	The type of this event. The value is `"customer.custom_attribute.visible.deleted"`.
`event_id string`	A unique ID for the event notification.
`created_at string`	Read only The timestamp that indicates when the event notification 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
`data CustomAttributeSquareEventData`	The data associated with the event that triggered the event notification.

Examples

All Versions

{
  "merchant_id": "DM7VKY8Q63GNP",
  "type": "customer.custom_attribute.visible.deleted",
  "event_id": "18ef5adc-2efc-4ad9-9b1a-b274a607da3e",
  "created_at": "2022-04-26T01:22:29Z",
  "data": {
    "type": "custom_attribute",
    "id": "sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size:CUSTOMER:TNQC0TYTWMRSFFQ157KK4V7MVR",
    "deleted": true,
    "object": {
      "created_at": "2022-04-21T21:58:59Z",
      "key": "sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size",
      "updated_at": "2022-04-27T11:31:29Z",
      "value": [
        "4032c1a2-d749-4c75-9c30-be6472cd2e08"
      ],
      "version": 3,
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    }
  }
}