0

DeleteCustomerCustomAttribute

by
Published Oct 17, 2025

Deletes a [custom attribute]($m/CustomAttribute) 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`.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * DeleteCustomerCustomAttribute
7
 * Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile.
8

9
To delete a custom attribute owned by another application, the `visibility` setting must be
10
`VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
11
(also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
12
 */
13
export async function main(auth: Square, customer_id: string, key: string) {
14
  const url = new URL(
15
    `https://connect.squareup.com/v2/customers/${customer_id}/custom-attributes/${key}`,
16
  );
17

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