0

Delete Multiple Records

by
Published today

Delete any number of records by ID, sent in batches of 10.

Script airtable Verified

The script

Submitted by hugo989 Typescript (fetch-only)
Verified 2 hours ago
1
//native
2

3
export type DynSelect_base_id = string
4
export type DynSelect_table_id = string
5

6
// Dropdown of the bases the token can access.
7
export async function base_id(auth: RT.Airtable) {
8
  const options: { value: string; label: string }[] = []
9
  let offset: string | undefined = undefined
10
  do {
11
    const url = new URL("https://api.airtable.com/v0/meta/bases")
12
    if (offset) {
13
      url.searchParams.append("offset", offset)
14
    }
15
    const response = await fetch(url, {
16
      headers: {
17
        Authorization: `Bearer ${auth.apiKey}`,
18
        Accept: "application/json",
19
      },
20
    })
21
    if (!response.ok) {
22
      throw new Error(`${response.status} ${await response.text()}`)
23
    }
24
    const page = (await response.json()) as {
25
      bases: { id: string; name: string }[]
26
      offset?: string
27
    }
28
    options.push(...page.bases.map((b) => ({ value: b.id, label: b.name })))
29
    offset = page.offset
30
  } while (offset)
31
  return options
32
}
33

34
async function listTables(auth: RT.Airtable, base_id: string) {
35
  if (!base_id) {
36
    return []
37
  }
38
  const response = await fetch(
39
    `https://api.airtable.com/v0/meta/bases/${base_id}/tables`,
40
    {
41
      headers: {
42
        Authorization: `Bearer ${auth.apiKey}`,
43
        Accept: "application/json",
44
      },
45
    }
46
  )
47
  if (!response.ok) {
48
    throw new Error(`${response.status} ${await response.text()}`)
49
  }
50
  const { tables } = (await response.json()) as {
51
    tables: {
52
      id: string
53
      name: string
54
      fields: { id: string; name: string; type: string }[]
55
      views: { id: string; name: string }[]
56
    }[]
57
  }
58
  return tables
59
}
60

61
// Dropdown of the tables in the chosen base.
62
export async function table_id(auth: RT.Airtable, base_id: DynSelect_base_id) {
63
  return (await listTables(auth, base_id)).map((t) => ({
64
    value: t.id,
65
    label: t.name,
66
  }))
67
}
68

69
/**
70
 * Delete Multiple Records
71
 * Delete any number of records by ID. Sent in batches of 10 (the API maximum), so a failure part-way leaves the earlier batches deleted.
72
 */
73
export async function main(
74
  auth: RT.Airtable,
75
  base_id: DynSelect_base_id,
76
  table_id: DynSelect_table_id,
77
  record_ids: string[]
78
) {
79
  const deleted: any[] = []
80
  // The API accepts at most 10 records per request.
81
  for (let i = 0; i < record_ids.length; i += 10) {
82
    const url = new URL(`https://api.airtable.com/v0/${base_id}/${table_id}`)
83
    for (const id of record_ids.slice(i, i + 10)) {
84
      url.searchParams.append("records[]", id)
85
    }
86
    const response = await fetch(url, {
87
      method: "DELETE",
88
      headers: {
89
        Authorization: `Bearer ${auth.apiKey}`,
90
        Accept: "application/json",
91
      },
92
    })
93
    if (!response.ok) {
94
      throw new Error(`${response.status} ${await response.text()}`)
95
    }
96
    deleted.push(...(await response.json()).records)
97
  }
98

99
  return { records: deleted }
100
}
101