API reference / Apps
Turn calls as the customer on or off
Liquid SaaS. On: each call of the Support agent in a chat with a signed-in customer carries the token of that customer, in place of the key of the app. The website mints the token and signs it with the email (identify with token and exp). header names the header of the token. Without it: Authorization, with Bearer. Needs an owner or admin.
patch
/api/v1/custom-apps/{slug}/visitor-authOther ways to call it
CLI
troopy custom-apps visitor-authMCP toolNone. Call it over REST or with the CLI.
Rate limit20 calls in 60 seconds, for each key
Path parameters
slug*stringThe id of the app, made from its name, as in acme_crm
Body
application/jsonon*booleanheaderstring | nullThe header that carries the token of the customer, as in X-Customer-Token
Response
200 · application/jsondata*object2 properties
slug*stringThe id of the app, made from its name, as in acme_crm
on*booleanErrors
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 an organization owner or admin.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
429 rate_limitedWait the number of seconds in Retry-After, then retry.