<- Location Custom Attributes API

Location Custom Attributes API

Create location custom attribute definitionBeta

POST

 /v2/locations/custom-attribute-definitions

Creates a location-related custom attribute definition for a Square seller account.

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.

Permissions:MERCHANT_PROFILE_WRITE

Guide

Create location custom attribute definition

Try in API Explorer
Link to section

Request body

Example code

Link to section

custom_attribute_definition

Required

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

idempotency_key

string

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

Max Length
45
Link to section

Response fields

Link to section

custom_attribute_definition

The new custom attribute definition.

Link to section

errors

Any errors that occurred during the request.