To let an assistant use these tools, grant Product configuration on the consent screen, or just
Presentations under its Fine-tune. The scope is presentations.
Read tools work with Read only or Read & write access; write tools only with
Read & write.
Your assistant doesn't see these tools straight away. It finds them with search_tools or
describe_tools, and runs one with use_tool, passing its name and
arguments. Most assistants do this for you: just ask for what you want.
What your assistant is told about this group
Presentations are how a journey shows its quote to customers, each built on one of the platform's ready-made templates: pick one from list_presentation_templates. A presentation's template_key can't be changed after it's created. Each journey has one default presentation, and set_default_presentation switches it in one step. Presentations can be archived, never deleted.
The descriptions below are the ones your assistant reads, so they're written for it. When a connection covers more than one
organisation, the assistant passes org (the organisation's slug, from list_orgs) to say which one.
list_presentations
Read List presentations
List a journey's presentations (which code-managed templates it offers customers), active first then archived.
Arguments
| Field | Type | Description |
|---|---|---|
| journey_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_presentation
Read Get a presentation
Fetch one presentation: template, stage keys, default flag, and any question keys the template references that the journey doesn't define.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Presentation id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_presentation_templates
Read List presentation templates
The code-managed presentation templates this organisation may attach to journeys (create_presentation takes a template_key from here).
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
create_presentation
Write Create a presentation
Attach a template to a journey as a customer-facing presentation. The template_key is locked after creation (see list_presentation_templates for available keys).
Arguments
| Field | Type | Description |
|---|---|---|
| journey_id required | string | |
| template_key required | string | |
| is_default | boolean | Make it the journey's default (fails if another default exists: use set_default_presentation to switch) |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
set_default_presentation
Write Set default presentation
Make a presentation its journey's default, in one step (the previous default stops being the default).
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Presentation id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
move_presentation
Write Reorder a presentation
Move a presentation to a new position (0-based) among the journey's presentations.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Presentation id |
| position required | integer | Target position, 0-based |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
set_presentation_archived
Write Archive or restore a presentation
archived: true takes the presentation out of customer flows and future releases (presentations are never deleted); archived: false restores it.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Presentation id |
| archived required | boolean | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |