0

Update a site redirect

by
Published Oct 17, 2025
Script gitbook Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Gitbook = {
3
  token: string;
4
};
5
/**
6
 * Update a site redirect
7
 *
8
 */
9
export async function main(
10
  auth: Gitbook,
11
  organizationId: string,
12
  siteId: string,
13
  siteRedirectId: string,
14
  body: {
15
    source?: string;
16
    destination?:
17
      | { kind: "site-section"; siteSectionId: string }
18
      | { kind: "site-space"; siteSpaceId: string }
19
      | { kind: "site-page"; siteSpaceId: string; pageId: string };
20
  },
21
) {
22
  const url = new URL(
23
    `https://api.gitbook.com/v1/orgs/${organizationId}/sites/${siteId}/redirects/${siteRedirectId}`,
24
  );
25

26
  const response = await fetch(url, {
27
    method: "PATCH",
28
    headers: {
29
      "Content-Type": "application/json",
30
      Authorization: "Bearer " + auth.token,
31
    },
32
    body: JSON.stringify(body),
33
  });
34
  if (!response.ok) {
35
    const text = await response.text();
36
    throw new Error(`${response.status} ${text}`);
37
  }
38
  return await response.json();
39
}
40