location custom_attribute_definition visible deletedBeta

EVENT

location.custom_attribute_definition.visible.deleted

Published when a location custom attribute definition that is visible to the subscribing application is deleted. A custom attribute definition can only be deleted by the application that created it. A notification is sent when your application deletes a custom attribute definition or when another application deletes a custom attribute definition whose visibility is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

Permissions:MERCHANT_PROFILE_READ

Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the seller associated with the event that triggered the event notification.

Link to section

type

string

The type of this event. The value is "location.custom_attribute_definition.visible.deleted".

Link to section

event_id

string

A unique ID for the event notification.

Link to section

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

Link to section

data

The data associated with the event that triggered the event notification.

Show attributes

Link to section

Examples

Response JSON

{
  "merchant_id": "DM7VKY8Q63GNP",
  "type": "location.custom_attribute_definition.visible.deleted",
  "event_id": "81c10a07-c329-4943-af20-7d70a300c7e6",
  "created_at": "2022-04-26T01:22:29Z",
  "data": {
    "type": "custom_attribute_definition",
    "id": "sq0idp-BushoY39o1X-GPxRRUWc0A:square-ft",
    "deleted": true,
    "object": {
      "created_at": "2022-04-21T21:40:49Z",
      "description": "Square footage of the facility.",
      "key": "sq0idp-BushoY39o1X-GPxRRUWc0A:square-ft",
      "name": "Facility Square Footage",
      "schema": {
        "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number"
      },
      "updated_at": "2022-04-27T11:31:29Z",
      "version": 3,
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    }
  }
}