Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Outreach

Sort a reply

Says what a reply is, which moves its person's stage: interested, or not_interested (which also puts them on do-not-contact); unsubscribe unsubscribes them; the rest (a question, not now, out of office, the wrong person) say they replied.

patch/api/v1/replies/{id}

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 replies sort
MCP tooltroopy_sort_reply
Rate limit120 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.

Path parameters

id*string

A 24-character id

Body

application/json
sort*enum<string>

interestedquestionnot_nownot_interestedout_of_officeunsubscribewrong_person

Response

200 · application/json
data*object
10 properties
id*string

A 24-character id

campaign*object | null
2 properties
id*string

A 24-character id

name*string
lead*object
5 properties
enrollment*string

A 24-character id

person*string

A 24-character id

email*string
name*string | null
status*enum<string>

activepausedrepliedbouncedunsubscribeddonestopped

mailbox*string

The address it came to

subject*string
body*string

Their words, without what they quoted, at most 8,000 characters

sort*enum<string> | null

What it says; null until someone sorts it

interestedquestionnot_nownot_interestedout_of_officeunsubscribewrong_person

sortedBy*object | null
3 properties
type*enum<string>

personagentapi

id*string
name*string
summary*string | null
receivedAt*string

ISO 8601 date and time

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