Update customer custom attribute definition
PUT
/v2/customers/custom-attribute-definitions/{key}
Updates a customer-related custom attribute definition for a Square seller account.
Use this endpoint to update the following fields: name
, description
, visibility
, or the
schema
for a Selection
data type.
Only the definition owner can update a custom attribute definition. Note that sellers can view
all custom attributes in exported customer data, including those set to VISIBILITY_HIDDEN
.
Path parameters
Example code
The custom attribute definition that contains the fields to update. This endpoint supports sparse updates, so only new or changed fields need to be included in the request. Only the following fields can be updated:
name
description
visibility
schema
for aSelection
data type. Only changes to the named options or the maximum number of allowed selections are supported.
For more information, see Updatable definition fields.
To enable optimistic concurrency
control, include the optional version
field and specify the current version of the custom attribute definition.
A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.