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

    Interface UpdateContent

    interface UpdateContent {
        ancestors?: { id: string }[];
        body?: {
            anonymous_export_view?: ContentBodyCreate;
            atlas_doc_format?: ContentBodyCreate;
            editor2?: ContentBodyCreate;
            export_view?: ContentBodyCreate;
            storage?: ContentBodyCreateStorage;
            styled_view?: ContentBodyCreate;
            view?: ContentBodyCreate;
        };
        conflictPolicy?: string;
        id: string;
        status?: string;
        statusBody?: "current"
        | "trashed"
        | "historical"
        | "draft";
        title: string;
        type: string;
        version: { message?: string; number: number };
    }

    Hierarchy (View Summary)

    Index

    Properties

    ancestors? body? conflictPolicy? id status? statusBody? title type version

    Properties

    ancestors?: { id: string }[]

    The new parent for the content. Only one parent content 'id' can be specified.

    Type declaration

    • id: string

      The id of the parent content.

    Optionalbody

    body?: {
        anonymous_export_view?: ContentBodyCreate;
        atlas_doc_format?: ContentBodyCreate;
        editor2?: ContentBodyCreate;
        export_view?: ContentBodyCreate;
        storage?: ContentBodyCreateStorage;
        styled_view?: ContentBodyCreate;
        view?: ContentBodyCreate;
    }

    The updated body of the content. Does not apply to attachments. If you are not sure how to generate these formats, you can create a page in the Confluence application, retrieve the content using Get content, and expand the desired content format, e.g. expand=body.storage.

    conflictPolicy?: string

    The action that should be taken when conflicts are discovered. Only used when publishing a draft page.

    id: string

    The ID of the content to be updated.

    status?: string

    The updated status of the content. Use this parameter to change the status of a piece of content without passing the entire request body.

    statusBody?: "current" | "trashed" | "historical" | "draft"

    The updated status of the content. Note, if you change the status of a page from 'current' to 'draft' and it has an existing draft, the existing draft will be deleted in favor of the updated page.

    title: string

    The updated title of the content. If you are not changing this field, set this to the current title.

    type: string

    The type of content. Set this to the current type of the content.

    version: { message?: string; number: number }

    The new version for the updated content. Set this to the current version number incremented by one, unless you are changing the status to 'draft' which must have a version number of 1.

    To get the current version number, use Get content by ID and retrieve version.number.

    Type declaration

    • Optionalmessage?: string

      The version comment.

    • number: number

      The version number.

    Settings

    Member Visibility

    On This Page

    Properties