0

Create Cross-sheet References

by
Published Oct 17, 2025

Adds a cross-sheet reference between two sheets and defines the data range for formulas. Each distinct data range requires a new cross-sheet reference.

Script smartsheet Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Smartsheet = {
3
  token: string;
4
  baseUrl: string;
5
};
6
/**
7
 * Create Cross-sheet References
8
 * Adds a cross-sheet reference between two sheets and defines the data range for formulas. Each distinct data range requires a new cross-sheet reference.
9
 */
10
export async function main(
11
  auth: Smartsheet,
12
  sheetId: string,
13
  body:
14
    | {
15
        sourceSheetId?: number;
16
        name?: string;
17
        endColumnId?: number;
18
        startColumnId?: number;
19
      }
20
    | {
21
        sourceSheetId?: number;
22
        name?: string;
23
        endRowId?: number;
24
        startRowId?: number;
25
      }
26
    | {
27
        sourceSheetId?: number;
28
        name?: string;
29
        endColumnId?: number;
30
        endRowId?: number;
31
        startColumnId?: number;
32
        startRowId?: number;
33
      },
34
) {
35
  const url = new URL(
36
    `${auth.baseUrl}/sheets/${sheetId}/crosssheetreferences`,
37
  );
38

39
  const response = await fetch(url, {
40
    method: "POST",
41
    headers: {
42
      "Content-Type": "application/json",
43
      Authorization: "Bearer " + auth.token,
44
    },
45
    body: JSON.stringify(body),
46
  });
47
  if (!response.ok) {
48
    const text = await response.text();
49
    throw new Error(`${response.status} ${text}`);
50
  }
51
  return await response.json();
52
}
53