<- Location Custom Attributes API

Location Custom Attributes API

Create location custom attribute definitionBeta



Use this endpoint to define a custom attribute that can be associated with locations. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom attribute. After the definition is created, you can call UpsertLocationCustomAttribute or BulkUpsertLocationCustomAttributes to set the custom attribute for locations.

Link to section

Request body

Example code

Link to section



The custom attribute definition to create. Note the following:

  • With the exception of the Selection data type, the schema is specified as a simple URL to the JSON schema definition hosted on the Square CDN. For more information, including supported values and constraints, see Supported data types.
  • name is required unless visibility is set to VISIBILITY_HIDDEN.
Link to section



A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

Link to section

Response fields

Link to section


The new custom attribute definition.

Link to section


Any errors that occurred during the request.