Skip to main content
TroopyDocs
GuidesSet up and use TroopyAppsConnect your servicesAPIThe API, the CLI and MCPChangelogEach update to Troopy

Developers

Account

Troop

Skills

Tasks and projects

Needs you

Routines and triggers

Brain

Docs

Canvas

Email

CRM

Outreach

Customers

Analytics

Sessions

Surveys

Support Agent

Tests and incidents

Disputes

Apps

Vault

Computer

Open Troopy
Troopy

API reference / Apps

Change a custom app

Changes the name of an app, its key, the mode of its tools, or which tools the Support agent calls for a visitor. free runs, ask waits for the yes of an owner or admin, off is never called. A new key lists the tools again. Needs an owner or admin.

patch/api/v1/custom-apps/{slug}

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.
Scopesapps:write

Other ways to call it

CLItroopy custom-apps update
MCP toolNone. Call it over REST or with the CLI.
Rate limit20 calls in 60 seconds, for each key

Path parameters

slug*string

The id of the app, made from its name, as in acme_crm

Body

application/json
namestring

At least 2 characters · At most 60 characters

keystring

A new key, for an app that has one

At least 8 characters · At most 2000 characters

toolsobject

The new mode of some tools, by their names

visitorobject

For some tools, by their names: the argument that takes the email of a visitor of the website, or null. The argument must be one of the tool. Then the Support agent calls the tool for a visitor that the website proved

Response

200 · application/json
data*object
12 properties
slug*string

The id of the app, made from its name, as in acme_crm

name*string
kind*enum<string>

A remote MCP server, or an OpenAPI document (Liquid SaaS)

mcpopenapi

url*string

The Streamable HTTP address of its MCP server

auth*enum<string>

How Troopy signs in: nothing, a key in a header, or the sign-in of the server

nonekeyoauth

status*enum<string>

connectedneeds_sign_infailed

error*string | null
tools*array<object>
5 properties
name*string
description*string
mode*enum<string>

free: it runs. ask: it waits for the yes of an owner or admin. off: no teammate calls it

freeaskoff

args*array<string>

The top-level arguments of the tool

visitor*string | null

The argument that takes the email of a visitor of the website. Then the Support agent calls the tool for a visitor that the website proved, and Troopy fills that argument in. Null: the Support agent never calls it

listedAt*string | null

When an owner or admin last read its tools

connectedBy*object

Who wrote it

3 properties
type*enum<string>

personagentapi

id*string
name*string
connectedAt*string

ISO 8601 date and time

signIn*string | null

The page that starts the sign-in of the server, while it waits for one. A person opens it

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 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.