Creates a customer-related custom attribute definition for a Square seller account.
Open in API Reference
The custom attribute definition to create. Note the following:
Seller-oriented description of the custom attribute definition, including any constraints
that the seller should observe. May be displayed as a tooltip in Square UIs. This field is
required if the visibility field is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
of the custom attribute definition and its corresponding custom attributes. This value
can be a simple key, which is the key that is provided when the custom attribute definition
is created, or a qualified key, if the requesting
application is not the definition owner. The qualified key consists of the application ID
of the custom attribute definition owner
followed by the simple key that was provided when the definition was created. It has the
format application_id:simple key.
The value for a simple key can contain up to 60 alphanumeric characters, periods (.),
underscores (_), and hyphens (-).
This field can not be changed
after the custom attribute definition is created. This field is required when creating
a definition and must be unique per application, seller, and resource type.
The name of the custom attribute definition for API and seller-facing UI purposes. The name must
be unique within the seller and application pair. This field is required if the
visibility field is VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.
The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,
see Custom Attributes Overview. This field is required when creating a definition.
Read only. The current version of the custom attribute definition.
The value is incremented each time the custom attribute definition is updated.
When updating a custom attribute definition, you can provide this field
and specify the current version of the custom attribute definition to enable
On writes, this field must be set to the latest version. Stale writes are rejected.
This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,
see Custom Attributes Overview.
Specifies how the custom attribute definition and its values should be shared with
the seller and other applications. If no value is specified, the value defaults to VISIBILITY_HIDDEN.
A unique identifier for this request, used to ensure idempotency. For more information,
// No response received yet.