• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
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

Path Parameters

Example code
Name Description
customer_id
string
Required

The ID of the target customer profile.
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.

Response Fields
Name Description
errors
Error [ ]

Any errors that occurred during the request.

Examples

You are viewing an old version of the API
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 
{}