Square API
You are viewing an old version of the API
Customer Custom Attributes
Square API
Create and manage customer-related custom attribute definitions and custom attributes.
Use the Customer Custom Attributes API to create and manage custom attributes for customer profiles. Custom attributes can be used to store properties or metadata that simplify integration, synchronization, and personalization workflows. After a custom attribute definition is created in a Square seller account, the custom attribute value can be set for customer profiles in the seller's Customer Directory.
-
List customer custom attribute definitions
GET /v2/customers/custom-attribute-definitions - Lists the customer-related custom attribute definitions that belong to a Square seller account.
BETA -
Create customer custom attribute definition
POST /v2/customers/custom-attribute-definitions - Creates a customer-related custom attribute definition for a Square seller account.
BETA -
Delete customer custom attribute definition
DELETE /v2/customers/custom-attribute-definitions/{key} - Deletes a customer-related custom attribute definition from a Square seller account.
BETA -
Retrieve customer custom attribute definition
GET /v2/customers/custom-attribute-definitions/{key} - Retrieves a customer-related custom attribute definition from a Square seller account.
BETA -
Update customer custom attribute definition
PUT /v2/customers/custom-attribute-definitions/{key} - Updates a customer-related custom attribute definition for a Square seller account.
BETA -
Bulk upsert customer custom attributes
POST /v2/customers/custom-attributes/bulk-upsert - Creates or updates custom attributes for customer profiles as a bulk operation.
BETA -
List customer custom attributes
GET /v2/customers/{customer_id}/custom-attributes - Lists the custom attributes associated with a customer profile.
BETA -
Delete customer custom attribute
DELETE /v2/customers/{customer_id}/custom-attributes/{key} - Deletes a custom attribute associated with a customer profile.
BETA -
Retrieve customer custom attribute
GET /v2/customers/{customer_id}/custom-attributes/{key} - Retrieves a custom attribute associated with a customer profile.
BETA -
Upsert customer custom attribute
POST /v2/customers/{customer_id}/custom-attributes/{key} - Creates or updates a custom attribute for a customer profile.
BETA