Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Support Agent

Change the guide of the chat

guides declares the places that the chat can show a customer, 20 at most. Each one has a name (as in data-troopy-guide), words for the Support agent, and the path of its page on your website. The chat opens the page only after the customer presses Show me. readsPage turns the read of the page on or off: with it, each message of the chat carries the names of the links and buttons of the page, never the value of a field, and the Support agent can point at one. What you leave out stays. Needs an owner or admin. Not found while Liquid SaaS is off.

patch/api/v1/support-liquid/guides

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy liquid set-guides
MCP toolNone. Call it over REST or with the CLI.
Rate limit20 calls in 60 seconds, for each key
RetriesSend an Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.

Body

application/json
guidesarray<object>

The places, all of them: this list takes the place of the list before

At most 20 items

3 properties
name*string
about*string

At least 1 characters · At most 120 characters

path*string

At most 200 characters

readsPageboolean

Whether the chat reads the names of the links and buttons of the page

toursarray<object>

The tours, all of them, 5 at most. The chat offers a tour one time to a visitor who opens its page (path). Each step names a declared place (to) and has one sentence (say)

At most 5 items

4 properties
name*string
title*string

At least 1 characters · At most 60 characters

path*string

At most 200 characters

steps*array<object>

At most 4 items

2 properties
to*string
say*string

At least 1 characters · At most 140 characters

Response

200 · application/json
data*object
3 properties
guides*array<object>
5 properties
name*string
about*string

At least 1 characters · At most 120 characters

path*string

At most 200 characters

mark*enum<string> | null

found: a page of the website had the mark of the place. missing: a customer pressed Show me, and its page had no mark. Null: no visitor opened the page yet

foundmissing

markAt*string | null

When the chat said so

readsPage*boolean
tours*array<object>

At most 5 items

4 properties
name*string
title*string

At least 1 characters · At most 60 characters

path*string

At most 200 characters

steps*array<object>

At most 4 items

2 properties
to*string
say*string

At least 1 characters · At most 140 characters

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask a company owner or admin.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.