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.
/api/v1/support-liquid/guidesOther ways to call it
troopy liquid set-guidesIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsonguidesarray<object>The places, all of them: this list takes the place of the list before
At most 20 items
3 properties
name*stringabout*stringAt least 1 characters · At most 120 characters
path*stringAt most 200 characters
readsPagebooleanWhether 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*stringtitle*stringAt least 1 characters · At most 60 characters
path*stringAt most 200 characters
steps*array<object>At most 4 items
2 properties
to*stringsay*stringAt least 1 characters · At most 140 characters
Response
200 · application/jsondata*object3 properties
guides*array<object>5 properties
name*stringabout*stringAt least 1 characters · At most 120 characters
path*stringAt most 200 characters
mark*enum<string> | nullfound: 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 | nullWhen the chat said so
readsPage*booleantours*array<object>At most 5 items
4 properties
name*stringtitle*stringAt least 1 characters · At most 60 characters
path*stringAt most 200 characters
steps*array<object>At most 4 items
2 properties
to*stringsay*stringAt least 1 characters · At most 140 characters