Delete customer custom attribute definition

DELETE

/v2/customers/custom-attribute-definitions/{key}

Deletes a customer-related custom attribute definition from a Square seller account.

Deleting a custom attribute definition also deletes the corresponding custom attribute from all customer profiles in the seller's Customer Directory.

Only the definition owner can delete a custom attribute definition.

Permissions:CUSTOMERS_WRITE

Guide

Delete customer custom attribute definition

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

key

string

Required

The key of the custom attribute definition to delete.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes

Link to section

Examples

DELETE /v2/customers/custom-attribute-definitions/{key}

curl https://connect.squareup.com/v2/customers/custom-attribute-definitions/favoritemovie \
  -X DELETE \
  -H 'Square-Version: 2023-03-15' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{}