Delete customer custom attribute

DELETE

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

Deletes a custom attribute associated with a customer profile.

To delete 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

Delete 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 delete. 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

Response fields

Link to section

errors

Any errors that occurred during the request.