• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
You are viewing an old version of the API

Booking custom attribute definition visible updated BETA

EVENT booking.custom_attribute_definition.visible.updated

Published when a booking custom attribute definition with the visibility field set to VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES is updated. An application that subscribes to this event is notified when a booking custom attribute definition is updated by any application for which the subscribing application has read access to the booking custom attribute definition.


Permissions
APPOINTMENTS_ALL_READ
APPOINTMENTS_READ
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 "booking.custom_attribute_definition.visible.updated".

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
CustomAttributeDefinitionSquareEventData

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

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "DM7VKY8Q63GNP",
  "type": "booking.custom_attribute_definition.visible.updated",
  "event_id": "ae376c21-d360-4694-96c7-1b27830f07d7",
  "created_at": "2022-04-26T01:22:29Z",
  "data": {
    "type": "custom_attribute_definition",
    "id": "sq0idp-BushoY39o1X-GPxRRUWc0A:party-size",
    "object": {
      "created_at": "2022-04-21T21:57:39Z",
      "description": "Number of party members",
      "key": "sq0idp-BushoY39o1X-GPxRRUWc0A:party-size",
      "name": "Party Size",
      "schema": {
        "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number"
      },
      "updated_at": "2022-04-26T01:22:29Z",
      "version": 2,
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    }
  }
}