@makehq/sdk
    Preparing search index...

    Type Alias BatchScenarioNotesUpdate

    A single note update within a batch request.

    Unlike ScenarioNotes.update, the batch route replaces rather than merges: an omitted content clears the content and omitted moduleIds unanchor the note, so both are required here to make that loss impossible by accident. metadata and isFilterNote are preserved when omitted and stay optional.

    type BatchScenarioNotesUpdate = {
        content: string;
        id: string;
        isFilterNote?: boolean;
        metadata?: ScenarioNoteMetadata;
        moduleIds: number[];
    }
    Index

    Properties

    content id isFilterNote? metadata? moduleIds

    Properties

    content

    content: string

    Content of the note as HTML. Required: the batch route clears the content when it is absent. Markdown is not rendered — see ScenarioNotes

    id: string

    ID of the note to update

    isFilterNote?: boolean

    Whether the note documents a filter. Left unchanged when omitted

    metadata?: ScenarioNoteMetadata

    New presentation metadata. Left unchanged when omitted

    moduleIds: number[]

    Module IDs the note is anchored to. Required: the batch route unanchors the note when absent

    Settings

    Member Visibility

    On This Page

    Properties