Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

Pin products to your sidebar

Sets the products that your sidebar lists in this workspace, in the order that you send them. Send every product to pin. A product that you leave out goes off the sidebar, and stays on the Products page.

patch/api/v1/me/products

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 products pin
MCP toolNone. Call it over REST or with the CLI.
Rate limit60 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
pinned*array<enum<string>>

The products to pin, by id, in the order of the sidebar. An empty list leaves only the Products page in the sidebar

docsemailcanvascrmsurveysanalyticssessionssupportinterviewsresearchvaultengineering

At most 12 items

Response

200 · application/json
data*array<object>
4 properties
id*enum<string>

docsemailcanvascrmsurveysanalyticssessionssupportinterviewsresearchvaultengineering

name*string
path*string

Its page in the app, under https://troopy.ai

pinned*boolean

Your sidebar lists it in this workspace

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