Confluence.js - Cloud and Server API library
    Preparing search index...

    Interface PublishSharedDraft

    interface PublishSharedDraft {
        ancestors?: { id: string }[];
        bodyStatus?: string;
        draftId: string;
        expand?: string[];
        space?: { key: string };
        status?: string;
        title: string;
        type: string;
        version: { number: number };
    }

    Hierarchy (View Summary)

    Index

    Properties

    ancestors? bodyStatus? draftId expand? space? status? title type version

    Properties

    ancestors?: { id: string }[]

    The new ancestor (i.e. parent page) for the content. If you have specified an ancestor, you must also specify a space property in the request body for the space that the ancestor is in.

    Note, if you specify more than one ancestor, the last ID in the array will be selected as the parent page for the content.

    Type declaration

    • id: string

      The content ID of the ancestor.

    bodyStatus?: string
    draftId: string

    The ID of the draft page that was created from a blueprint. You can find the draftId in the Confluence application by opening the draft page and checking the page URL.

    expand?: string[]

    A multi-value parameter indicating which properties of the content to expand.

    space?: { key: string }

    The space for the content.

    Type declaration

    • key: string

      The key of the space

    status?: string

    The status of the content to be updated, i.e. the draft. This is set to 'draft' by default, so you shouldn't need to specify it.

    title: string

    The title of the content. If you don't want to change the title, set this to the current title of the draft.

    type: string

    The type of content. Set this to page.

    version: { number: number }

    The version for the new content.

    Type declaration

    • number: number

      The version number. Set this to 1.

    Settings

    Member Visibility

    On This Page

    Properties