0

DeleteLocationCustomAttribute

by
Published Oct 17, 2025

Deletes a [custom attribute]($m/CustomAttribute) associated with a location. To delete a custom attribute owned by another application, the `visibility` setting must be `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
 * DeleteLocationCustomAttribute
7
 * Deletes a [custom attribute]($m/CustomAttribute) associated with a location.
8
To delete a custom attribute owned by another application, the `visibility` setting must be
9
`VISIBILITY_READ_WRITE_VALUES`.
10
 */
11
export async function main(auth: Square, location_id: string, key: string) {
12
  const url = new URL(
13
    `https://connect.squareup.com/v2/locations/${location_id}/custom-attributes/${key}`,
14
  );
15

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