To let an assistant use these tools, grant Product configuration on the consent screen, or just
Mini-sites under its Fine-tune. The scope is sites.
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
Your hosted mini-sites: settings and branding, pages in the menu with buttons that start a product or journey, custom domains and short-link domains (added here, then verified once their DNS points at Subcontext). Publishing or deleting a site changes what the public sees: confirm with the user first. Logos and favicons are uploaded in the dashboard.
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_sites
Read List mini-sites
The org's hosted mini-sites (marketing and quote pages on its own subdomain or domain). Manager or owner, on a plan with mini-sites.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_site
Read Get a mini-site
One mini-site with its settings, pages in nav order, custom domains and short-link domains.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
create_site
Write Create a mini-site
Creates a mini-site (unpublished until published is set). slug and name default from the org. Logo and favicon are uploaded in the dashboard.
Arguments
| Field | Type | Description |
|---|---|---|
| slug | string | The subdomain (<slug>.sites...). |
| name | string | |
| tagline | string | |
| contact_email | string | |
| contact_phone | string | |
| primary_color | string | |
| secondary_color | string | |
| accent_color | string | |
| font_family | string | |
| default_product_id | string | |
| default_journey_id | string | |
| default_presentation_id | string | |
| offers_all_products | boolean | |
| offered_product_ids | array of string | |
| chat_agent_id | string | |
| policy_admin_agent_id | string | |
| chat_font_size_px | integer | |
| webchat_enabled | boolean | |
| policy_admin_webchat_enabled | boolean | |
| webchat_omni | array of string | Channels the web chat offers to continue on. |
| published | boolean | true makes the site live to the public. |
| footer_markdown | string | |
| seo_description | string | |
| template_html | string | |
| use_org_hosted_templates | boolean | |
| hosted_dd_template_html | string | |
| hosted_payment_template_html | string | |
| hosted_policy_template_html | string | |
| password | string | Sets a site password (blank keeps the current one). |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
update_site
Write Update a mini-site
Changes a mini-site; only the fields given change. Setting published true puts it live for the public: confirm first. clear_password removes password protection.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| slug | string | The subdomain (<slug>.sites...). |
| name | string | |
| tagline | string | |
| contact_email | string | |
| contact_phone | string | |
| primary_color | string | |
| secondary_color | string | |
| accent_color | string | |
| font_family | string | |
| default_product_id | string | |
| default_journey_id | string | |
| default_presentation_id | string | |
| offers_all_products | boolean | |
| offered_product_ids | array of string | |
| chat_agent_id | string | |
| policy_admin_agent_id | string | |
| chat_font_size_px | integer | |
| webchat_enabled | boolean | |
| policy_admin_webchat_enabled | boolean | |
| webchat_omni | array of string | Channels the web chat offers to continue on. |
| published | boolean | true makes the site live to the public. |
| footer_markdown | string | |
| seo_description | string | |
| template_html | string | |
| use_org_hosted_templates | boolean | |
| hosted_dd_template_html | string | |
| hosted_payment_template_html | string | |
| hosted_policy_template_html | string | |
| password | string | Sets a site password (blank keeps the current one). |
| clear_password | boolean | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
delete_site
Write Delete a mini-site
PERMANENT. Deletes a mini-site with its pages and domains; its links stop working. Confirm with the user first.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
create_site_page
Write Add a page to a mini-site
Adds a page (last in the nav unless nav_position is given). The CTA fields point its button at a product, journey and presentation.
Arguments
| Field | Type | Description |
|---|---|---|
| site_id required | string | |
| slug required | string | "home" is the site root. |
| title required | string | |
| headline | string | |
| subheadline | string | |
| body_markdown | string | |
| body_html | string | |
| cta_label | string | |
| cta_product_id | string | |
| cta_journey_id | string | |
| cta_presentation_id | string | |
| chat_agent_id | string | This page's own chat agent; blank = the site's. |
| show_in_nav | boolean | |
| chat_widget_enabled | boolean | |
| nav_position | integer | |
| seo_description | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
update_site_page
Write Update a mini-site page
Changes a page; only the fields given change.
Arguments
| Field | Type | Description |
|---|---|---|
| site_id required | string | |
| id required | string | |
| slug | string | "home" is the site root. |
| title | string | |
| headline | string | |
| subheadline | string | |
| body_markdown | string | |
| body_html | string | |
| cta_label | string | |
| cta_product_id | string | |
| cta_journey_id | string | |
| cta_presentation_id | string | |
| chat_agent_id | string | This page's own chat agent; blank = the site's. |
| show_in_nav | boolean | |
| chat_widget_enabled | boolean | |
| nav_position | integer | |
| seo_description | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
delete_site_page
Write Delete a mini-site page
PERMANENT. Deletes a page (not the home page); links to it stop working.
Arguments
| Field | Type | Description |
|---|---|---|
| site_id required | string | |
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
move_site_page
Write Move a mini-site page in the nav
Swaps a page with its neighbour in the navigation (up or down).
Arguments
| Field | Type | Description |
|---|---|---|
| site_id required | string | |
| id required | string | |
| direction required | string |
One of: "up", "down"
|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
add_site_domain
Write Add a custom domain to a mini-site
Adds a custom hostname (e.g. www.example.com) and queues a DNS check; the setup steps are on the domain page (url).
Arguments
| Field | Type | Description |
|---|---|---|
| site_id required | string | |
| hostname required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
remove_site_domain
Write Remove a custom domain
The site stops answering on that hostname. Confirm first.
Arguments
| Field | Type | Description |
|---|---|---|
| site_id required | string | |
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
verify_site_domain
Write Recheck a custom domain
Queues a DNS verification check; read the status back with get_site in a moment.
Arguments
| Field | Type | Description |
|---|---|---|
| site_id required | string | |
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
add_short_domain
Write Add a short-link domain
Adds a branded hostname for short links and queues a DNS (CNAME) check.
Arguments
| Field | Type | Description |
|---|---|---|
| site_id required | string | |
| hostname required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
remove_short_domain
Write Remove a short-link domain
Short links on that hostname stop working. Confirm first.
Arguments
| Field | Type | Description |
|---|---|---|
| site_id required | string | |
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
verify_short_domain
Write Recheck a short-link domain
Queues a DNS verification check.
Arguments
| Field | Type | Description |
|---|---|---|
| site_id required | string | |
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |