To let an assistant use these tools, grant Product configuration on the consent screen, or just
Releases under its Fine-tune. The scope is releases.
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
How changes go live. Changes to a product, its covers, journeys, questions, presentations, documents and lifecycle events are drafts until a release is published. get_draft_changes shows what has changed since the live release; publish_release publishes it all as the next release (and can put journeys on sale at the same time); get_release shows what a past release changed. rollback_release makes an older release live again and resets the drafts to match it. It's refused while there are unpublished changes that could be discarded: publish or discard them first. Releases are never edited or 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_releases
Read List releases
A product's published releases (never edited or deleted) and which one is live. A rollback makes an older release live again without creating a new one.
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_release
Read Get a release
One published release and the per-entity diff against its predecessor: what this release changed when it shipped.
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | |
| release_number required | integer | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
publish_release
Write Publish a release
Publish the product's drafts as its next release: this is how EVERY change to a product, its covers, journeys, questions, presentations, documents and lifecycle events goes live. It can also put sandbox or draft journeys on sale at the same time. Check get_draft_changes first to see what will go live.
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | |
| title | string | Optional release title |
| notes | string | Optional release notes |
| launch_journey_ids | array of string | Journeys to put on sale immediately after publishing |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
rollback_release
Write Roll back to a release
Make an older published release live again, and reset the drafts to match it. Refused while there are unpublished changes that could be discarded: discard or publish them first. Applications in progress and policies already issued keep the versions they were sold under.
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | |
| release_number required | integer | The published release to make live again |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
discard_entity_changes
Write Discard an entity's unpublished changes
Throw away the unpublished changes to one item, putting it back as it is in the live release (a document's draft is dropped). Get container_type and container_id from get_draft_changes.
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | |
| container_type required | string |
Entity type (full class names also accepted)
One of: "product", "cover", "journey", "presentation", "lifecycle_events", "document"
|
| container_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_entity_history
Read Get an entity's version history
Every released version of one item (newest first), what changed from the version before, field by field, and which published releases use each version.
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | |
| container_type required | string |
Entity type (full class names also accepted)
One of: "product", "cover", "journey", "presentation", "lifecycle_events", "document"
|
| container_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_entity_diff
Read Get an entity's line-by-line diff
Line-by-line changes to one item, as the release pages show them. By default: the unpublished draft against the live release (what publishing would change). Pass to_release to see what that release changed compared with from_release (or the release before it). Get container_type and container_id from get_draft_changes.
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | |
| container_type required | string |
Entity type (full class names also accepted)
One of: "product", "cover", "journey", "presentation", "lifecycle_events", "document"
|
| container_id required | string | |
| from_release | integer | Baseline release number (defaults to to_release's predecessor) |
| to_release | integer | Omit to diff the unpublished draft against live |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
clone_release_as_product
Write Clone a release as a new product
Copy a published release's exact configuration into a new draft product, ignoring any changes made since. A large product is copied in the background: the response then gives a background operation id instead.
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | |
| release_number required | integer | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_preview_url
Write Get a customer preview URL
A signed link to go through a journey as a customer would. Leave out release_number to preview the UNPUBLISHED drafts (this saves them as the draft release, and calling again gives the same result); pass one to preview a published release.
Arguments
| Field | Type | Description |
|---|---|---|
| product_id required | string | |
| journey_id required | string | |
| presentation_id | string | Defaults to the journey's default presentation |
| release_number | integer | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |