Thankly SDK for JavaScript
    Preparing search index...

    Interface PlaybookBody

    The editable body of an engagement playbook.

    interface PlaybookBody {
        audience_description?: string;
        description?: string;
        eligible_for: PlaybookSurface[];
        engagement?: PlaybookEngagementBlock | null;
        excluded_capabilities?: string[];
        goal: string;
        must_mention?: string[];
        must_not_mention?: string[];
        name: string;
        playbook_id: string;
        pre_filter?: PreFilter;
        tone_hint?: string;
    }
    Index
    audience_description? description? eligible_for engagement? excluded_capabilities? goal must_mention? must_not_mention? name playbook_id pre_filter? tone_hint?
    audience_description?: string

    Who this playbook is for, in prose.

    description?: string

    Detailed description with relevant details and benefits

    eligible_for: PlaybookSurface[]

    Which surfaces this playbook may steer. Required — there is no default.

    engagement?: PlaybookEngagementBlock | null

    Delivery settings. Required when eligible_for includes 'engagement'.

    excluded_capabilities?: string[]

    Capabilities barred from this playbook's engagement blocks. Defaults to [].

    goal: string

    The goal of the quiz (e.g., 'personalize shopping experience')

    must_mention?: string[]

    Points the copy is required to include.

    must_not_mention?: string[]

    Points the copy must avoid.

    name: string

    Product name

    playbook_id: string

    Playbook identifier.

    pre_filter?: PreFilter

    Audience filter applied before the decision runs.

    tone_hint?: string

    Desired tone for generated copy.

    Settings
    Member Visibility

    On This Page
    Properties