Upsert customer custom attribute

POST

/v2/customers/{customer_id}/custom-attributes/{key}

Creates or updates a custom attribute for a customer profile.

Use this endpoint to set the value of a custom attribute for a specified customer profile. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the CreateCustomerCustomAttributeDefinition endpoint.

To create or update a custom attribute owned by another application, the visibility setting must be VISIBILITY_READ_WRITE_VALUES. Note that seller-defined custom attributes (also known as custom fields) are always set to VISIBILITY_READ_WRITE_VALUES.

Permissions:CUSTOMERS_WRITE

Guide

Upsert customer custom attribute

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

customer_id

string

Required

The ID of the target customer profile.

Link to section

key

string

Required

The key of the custom attribute to create or update. This key must match the key of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.

Link to section

Request body

Link to section

custom_attribute

Required

The custom attribute to create or update, with the following fields:

value. This value must conform to the schema specified by the definition. For more information, see Value data types.
version. To enable optimistic concurrency control for an update operation, include this optional field and specify the current version of the custom attribute.

Link to section

idempotency_key

string

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

Max Length

Link to section

Response fields

Link to section

custom_attribute

The new or updated custom attribute.

Link to section

errors

Any errors that occurred during the request.