0

DeleteCustomerCustomAttributeDefinition

by
Published Oct 17, 2025

Deletes a customer-related [custom attribute definition]($m/CustomAttributeDefinition) 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.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * DeleteCustomerCustomAttributeDefinition
7
 * Deletes a customer-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square seller account.
8

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

12
Only the definition owner can delete a custom attribute definition.
13
 */
14
export async function main(auth: Square, key: string) {
15
  const url = new URL(
16
    `https://connect.squareup.com/v2/customers/custom-attribute-definitions/${key}`,
17
  );
18

19
  const response = await fetch(url, {
20
    method: "DELETE",
21
    headers: {
22
      Authorization: "Bearer " + auth.token,
23
    },
24
    body: undefined,
25
  });
26
  if (!response.ok) {
27
    const text = await response.text();
28
    throw new Error(`${response.status} ${text}`);
29
  }
30
  return await response.json();
31
}
32