@makehq/sdk
    Preparing search index...

    Class ScenarioNotes

    Class providing methods for working with scenario notes.

    Every method is scoped by the parent scenario ID. The teamId and organizationId query parameters documented for these endpoints are never read by the API, so they are not offered.

    content is stored and rendered as HTML. The API keeps whatever string it is given, minus any tags the server-side sanitizer strips, and performs no Markdown conversion — Markdown syntax therefore survives the round trip untouched and shows up on the scenario canvas as the literal characters ###, ** and ` rather than as formatting. Send HTML:

    // Renders as a heading, bold text and a list
    await make.scenarioNotes.create(scenarioId, {
    content: '<h3>Title</h3><p>Some <strong>bold</strong> text</p><ul><li>item</li></ul>',
    });

    // Renders as the raw characters, not as formatting
    await make.scenarioNotes.create(scenarioId, {
    content: '### Title\n\nSome **bold** text\n\n- item',
    });

    Converting Markdown (or anything else) to HTML is the caller's job; this SDK passes content through unchanged in both directions.

    Index

    Constructors

    Methods

    • Create, update and delete several notes of a scenario in one request.

      This route is not a batched equivalent of the single-note methods. Entries in create are sent with an empty metadata object when none is given, because the route stores the value verbatim and fails with a server error when it is absent. Entries in update replace rather than merge, which is why BatchScenarioNotesUpdate requires content and moduleIds.

      Parameters

      • scenarioId: number

        The scenario ID to apply the changes to

      • body: BatchScenarioNotesBody

        The notes to create, update and delete

      Returns Promise<BatchScenarioNotesResult>

      The created and updated notes and the IDs of the deleted ones

    • Delete a scenario note.

      Parameters

      • scenarioId: number

        The scenario ID the note belongs to

      • noteId: string

        The note ID to delete

      Returns Promise<string>

      ID of the deleted note