To let an assistant use these tools, grant Product configuration on the consent screen, or just
Journeys, questions & answers under its Fine-tune. The scope is journeys.
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
Journeys are the question flows customers answer to get a quote. To build one: create_journey, then add questions with create_question, then promote the journey to sandbox to test it. A multiple-choice question (type enum) can't be saved without answer options, so create it as another type, add its options with create_answer_option, then change its type to enum. A journey only reaches customers once a published release includes it. Editing questions changes the draft: customers keep seeing the version in the live release until the next one is published.
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_journeys
Read List journeys
List a product's journeys (question flows) with lifecycle and release state.
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_journey
Read Get a journey
Fetch a journey with its full question graph (questions, answer options) and per-question release states (unreleased/new/changed/published).
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Journey id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
create_journey
Write Create a journey
Add a question-flow journey to a product. It starts as a draft; add questions, then promote to sandbox for testing. Production requires a published release.
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
| name required | string | |
| slug required | string | Lowercase letters, digits and hyphens; unique within the product |
| description | string | |
| journey_loading | string | Premium multiplier for this journey, 1.00-5.00 |
| position | integer | Display order (defaults to appended) |
update_journey
Write Update a journey
Update a journey's draft. Only the fields you pass change. Changes reach customers with the next published release.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Journey id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
| name | string | |
| slug | string | Lowercase letters, digits and hyphens; unique within the product |
| description | string | |
| journey_loading | string | Premium multiplier for this journey, 1.00-5.00 |
| position | integer | Display order (defaults to appended) |
promote_journey
Write Promote a journey
Move a journey to sandbox (internal testing) or production (on sale). Production is refused until a published release carries this journey: publish one first (publish_release).
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Journey id |
| target required | string |
One of: "sandbox", "production"
|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
archive_journey
Write Archive a journey
Retire a journey. It stops being offered and is left out of future releases; applications in progress and policies already issued are unaffected.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Journey id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
move_journey
Write Reorder a journey
Move a journey to a new position (0-based) among the product's journeys.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Journey id |
| position required | integer | Target position, 0-based |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
clone_journey
Write Clone a journey
Deep-copy a journey (questions, answer options, presentations) into a fresh draft with a new slug. Version pointers reset; runtime data is never copied.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Source journey id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
create_question
Write Create a question
Add a question to a journey (at the end, unless you give a position). It goes live with the next published release. A multiple-choice question (enum or multi_select) can't be saved without answer options: create it as another type, add its options with create_answer_option, then change its type with update_question.
Arguments
| Field | Type | Description |
|---|---|---|
| journey_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
| key required | string | Snake_case identifier, unique within the journey (e.g. smoker_status) |
| label required | string | The question as shown to the customer |
| help_text | string | |
| question_type | string |
One of: "date", "string", "number", "integer", "boolean", "enum", "multi_select", "derived"
|
| group_key | string | Cosmetic authoring group (presentations own customer-facing staging) |
| group_label | string | |
| position | integer | |
| required | boolean | |
| precision | string | |
| lookup_source | string | |
| formula | string | For derived questions |
| derived_from | array of string | Question keys a derived question reads |
| validation_min | number | Numeric types only |
| validation_max | number | Numeric types only |
update_question
Write Update a question
Update a question's draft. Only the fields you pass change. Changes go live with the next published release.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Question id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
| key | string | Snake_case identifier, unique within the journey (e.g. smoker_status) |
| label | string | The question as shown to the customer |
| help_text | string | |
| question_type | string |
One of: "date", "string", "number", "integer", "boolean", "enum", "multi_select", "derived"
|
| group_key | string | Cosmetic authoring group (presentations own customer-facing staging) |
| group_label | string | |
| position | integer | |
| required | boolean | |
| precision | string | |
| lookup_source | string | |
| formula | string | For derived questions |
| derived_from | array of string | Question keys a derived question reads |
| validation_min | number | Numeric types only |
| validation_max | number | Numeric types only |
delete_question
Write Delete a question
Delete a question, and its answer options, from the journey's draft. Past releases keep the question as it was.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Question id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
move_question
Write Reorder a question
Move a question to a new position (0-based) within its journey.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Question id |
| position required | integer | Target position, 0-based |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
clone_question
Write Clone a question
Copy a question with its answer options (key gets a suffix when cloning within the same journey).
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Source question id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
create_answer_option
Write Create an answer option
Add an option to a multiple-choice question (enum or multi_select).
Arguments
| Field | Type | Description |
|---|---|---|
| question_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
| value required | string | Stored answer value, unique within the question |
| label required | string | Customer-facing label |
| position | integer | |
| terminal_outcome | string |
Selecting this option ends the journey: decline, refer or postpone. Only enum/multi_select questions may carry one.
One of: "decline", "refer", "postpone"
|
| terminal_reason_code | string | Required when terminal_outcome is set |
| terminal_reason_message | string |
update_answer_option
Write Update an answer option
Update an answer option. Only supplied attributes change; pass an empty string to clear a terminal field.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Answer option id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
| value | string | Stored answer value, unique within the question |
| label | string | Customer-facing label |
| position | integer | |
| terminal_outcome | string |
Selecting this option ends the journey: decline, refer or postpone. Only enum/multi_select questions may carry one.
One of: "decline", "refer", "postpone"
|
| terminal_reason_code | string | Required when terminal_outcome is set |
| terminal_reason_message | string |
delete_answer_option
Write Delete an answer option
Remove an answer option from a question's draft.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Answer option id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
move_answer_option
Write Reorder an answer option
Move an answer option to a new position (0-based) within its question.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Answer option id |
| position required | integer | Target position, 0-based |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |