Function: updatePageTitle()

function updatePageTitle(client, parameters): Promise<{
[key: string]: unknown;
  _links?:   | {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
   }
     | null;
  authorId?: string;
  body?:   | {
   [key: string]: unknown;
     atlas_doc_format?:   | {
      [key: string]: unknown;
        representation?: string;
        value?: string;
      }
        | null;
     storage?:   | {
      [key: string]: unknown;
        representation?: string;
        value?: string;
      }
        | null;
     view?:   | {
      [key: string]: unknown;
        representation?: string;
        value?: string;
      }
        | null;
   }
     | null;
  createdAt?: Date;
  id?: string;
  isFavoritedByCurrentUser?: boolean;
  labels?:   | {
   [key: string]: unknown;
     _links?:   | {
      [key: string]: unknown;
        base?: string;
        byOperation?: string;
        collection?: string;
        context?: string;
        download?: string;
        editui?: string;
        edituiv2?: string;
        next?: string;
        prev?: string;
        self?: string;
        tinyui?: string;
        webui?: string;
      }
        | null;
     meta?:   | {
      [key: string]: unknown;
        count?: number;
        cursor?: string;
        hasMore?: boolean;
      }
        | null;
     results?: object[] | null;
   }
     | null;
  lastOwnerId?: string | null;
  likes?:   | {
   [key: string]: unknown;
     _links?:   | {
      [key: string]: unknown;
        base?: string;
        byOperation?: string;
        collection?: string;
        context?: string;
        download?: string;
        editui?: string;
        edituiv2?: string;
        next?: string;
        prev?: string;
        self?: string;
        tinyui?: string;
        webui?: string;
      }
        | null;
     meta?:   | {
      [key: string]: unknown;
        count?: number;
        cursor?: string;
        hasMore?: boolean;
      }
        | null;
     results?: object[] | null;
   }
     | null;
  operations?:   | {
   [key: string]: unknown;
     _links?:   | {
      [key: string]: unknown;
        base?: string;
        byOperation?: string;
        collection?: string;
        context?: string;
        download?: string;
        editui?: string;
        edituiv2?: string;
        next?: string;
        prev?: string;
        self?: string;
        tinyui?: string;
        webui?: string;
      }
        | null;
     meta?:   | {
      [key: string]: unknown;
        count?: number;
        cursor?: string;
        hasMore?: boolean;
      }
        | null;
     results?: object[] | null;
   }
     | null;
  ownerId?: string | null;
  parentId?: string | null;
  parentType?: "page" | "embed" | "whiteboard" | "database" | "folder" | null;
  position?: number | null;
  properties?:   | {
   [key: string]: unknown;
     _links?:   | {
      [key: string]: unknown;
        base?: string;
        byOperation?: string;
        collection?: string;
        context?: string;
        download?: string;
        editui?: string;
        edituiv2?: string;
        next?: string;
        prev?: string;
        self?: string;
        tinyui?: string;
        webui?: string;
      }
        | null;
     meta?:   | {
      [key: string]: unknown;
        count?: number;
        cursor?: string;
        hasMore?: boolean;
      }
        | null;
     results?: object[] | null;
   }
     | null;
  spaceId?: string;
  status?:   | "deleted"
     | "any"
     | "current"
     | "historical"
     | "draft"
     | "trashed"
     | "archived";
  title?: string;
  version?:   | {
   [key: string]: unknown;
     attachment?: Record<string, any>;
     authorId?: string;
     comment?: Record<string, any>;
     contributorIds?: unknown[];
     createdAt?: Date;
     message?: string | null;
     minorEdit?: boolean;
     ncsStepVersion?: string | null;
     number?: number;
   }
     | null;
  versions?:   | {
   [key: string]: unknown;
     _links?:   | {
      [key: string]: unknown;
        base?: string;
        byOperation?: string;
        collection?: string;
        context?: string;
        download?: string;
        editui?: string;
        edituiv2?: string;
        next?: string;
        prev?: string;
        self?: string;
        tinyui?: string;
        webui?: string;
      }
        | null;
     meta?:   | {
      [key: string]: unknown;
        count?: number;
        cursor?: string;
        hasMore?: boolean;
      }
        | null;
     results?: object[] | null;
   }
     | null;
}>;

Defined in: src/v2/api/page.ts:179

Updates the title of a specified page.

Permissions required: Permission to view the page and its corresponding space. Permission to update pages in the space.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ body?: Record<string, any>; id: number; }	-
parameters.body?	Record<string, any>	-
parameters.id	number	The ID of the page to be updated. If you don't know the page ID, use Get Pages and filter the results

Returns

Promise<{ [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; authorId?: string; body?: | { [key: string]: unknown; atlas_doc_format?: | { [key: string]: unknown; representation?: string; value?: string; } | null; storage?: | { [key: string]: unknown; representation?: string; value?: string; } | null; view?: | { [key: string]: unknown; representation?: string; value?: string; } | null; } | null; createdAt?: Date; id?: string; isFavoritedByCurrentUser?: boolean; labels?: | { [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; meta?: | { [key: string]: unknown; count?: number; cursor?: string; hasMore?: boolean; } | null; results?: object[] | null; } | null; lastOwnerId?: string | null; likes?: | { [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; meta?: | { [key: string]: unknown; count?: number; cursor?: string; hasMore?: boolean; } | null; results?: object[] | null; } | null; operations?: | { [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; meta?: | { [key: string]: unknown; count?: number; cursor?: string; hasMore?: boolean; } | null; results?: object[] | null; } | null; ownerId?: string | null; parentId?: string | null; parentType?: "page" | "embed" | "whiteboard" | "database" | "folder" | null; position?: number | null; properties?: | { [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; meta?: | { [key: string]: unknown; count?: number; cursor?: string; hasMore?: boolean; } | null; results?: object[] | null; } | null; spaceId?: string; status?: | "deleted" | "any" | "current" | "historical" | "draft" | "trashed" | "archived"; title?: string; version?: | { [key: string]: unknown; attachment?: Record<string, any>; authorId?: string; comment?: Record<string, any>; contributorIds?: unknown[]; createdAt?: Date; message?: string | null; minorEdit?: boolean; ncsStepVersion?: string | null; number?: number; } | null; versions?: | { [key: string]: unknown; _links?: | { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; } | null; meta?: | { [key: string]: unknown; count?: number; cursor?: string; hasMore?: boolean; } | null; results?: object[] | null; } | null; }>