Development
  • Guides
  • API Reference
  • API Explorer
  • SDKs
  • Sample apps
  • System status
Support
  • Developer forums
  • Developer blog
  • YouTube
  • X
More
  • Square Home
  • Square Developer
  • App Marketplace
  • Partner with Square
  • Solutions Partner Program
  • Pricing
  • Sales

© 2026 Square, Inc.

  • Developer terms of service
  • Developer Integration and Marketing Agreement
  • Privacy policy
  • Partnerships
  • Sign In
  • Sign In

    Location Custom Attributes

  • List location custom attribute definitions

  • Create location custom attribute definition

  • Delete location custom attribute definition

  • Retrieve location custom attribute definition

  • Update location custom attribute definition

  • Bulk delete location custom attributes

  • Bulk upsert location custom attributes

  • List location custom attributes

  • Delete location custom attribute

  • Retrieve location custom attribute

  • Upsert location custom attribute

  • Webhooks

  • location.custom_attribute_definition.owned.created

  • location.custom_attribute_definition.owned.deleted

  • location.custom_attribute_definition.owned.updated

  • location.custom_attribute_definition.visible.created

  • location.custom_attribute_definition.visible.deleted

  • location.custom_attribute_definition.visible.updated

  • location.custom_attribute.owned.deleted

  • location.custom_attribute.owned.updated

  • location.custom_attribute.visible.deleted

  • location.custom_attribute.visible.updated

<- Location Custom Attributes webhooks

Location Custom Attributes webhooks

All versions ->

location custom_attribute_definition visible updatedBeta

EVENT

 location.custom_attribute_definition.visible.updated

Published when a location custom attribute definition that is visible to the subscribing application is updated. A custom attribute definition can only be updated by the application that created it. A notification is sent when your application updates a custom attribute definition or when another application updates 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.updated".

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.

Link to section

Examples

All versions ->

Response JSON

{ "merchant_id": "DM7VKY8Q63GNP", "type": "location.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:square-ft", "object": { "created_at": "2022-04-21T21:57:39Z", "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-26T01:22:29Z", "version": 2, "visibility": "VISIBILITY_READ_WRITE_VALUES" } } }