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
.
Name | Description |
---|---|
customer_
Required
|
The ID of the target customer profile. |
key
Required
|
The key of the custom attribute to delete. This key must match the |
Response Fields
Name | Description |
---|---|
errors
|
Any errors that occurred during the request. |
Examples
DELETE
/v2/customers/{customer_id}/custom-attributes/{key}
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
- Node.js
curl https://connect.squareup.com/v2/customers/Z57QXKM2FGXEQDV42W8RBZY7BR/custom-attributes/favoritemovie \
-X DELETE \
-H 'Square-Version: 2023-01-19' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Response JSON
{}