Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Needs you

Update a draft

Edits a draft's title or body, or marks it used (you sent or published it yourself), discarded, or ready again. The words of a draft in Docs change in its doc, with PATCH /docs/{slug}. Troopy never sends or publishes a draft.

patch/api/v1/drafts/{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 drafts update
MCP tooltroopy_update_draft
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.

Path parameters

id*string

A 24-character id

Body

application/json
titlestring

At least 1 characters · At most 200 characters

bodystring

At least 1 characters · At most 20000 characters

statusenum<string>

readyuseddiscarded

Response

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

A 24-character id

agent*string

The teammate that wrote it

kind*enum<string>

postemailarticlecopybriefother

title*string
body*string

The piece, in markdown

flags*array<string>

What a person checks before use. For an article: the numbers that no page of its run shows

channel*string | null

Where it goes, like linkedin or newsletter

status*enum<string>

ready: waiting for a person. Nothing is sent or published by Troopy

readyuseddiscarded

runId*string

A 24-character id

threadId*string | null

The conversation it came from

taskId*string | null

The task it was written for

doc*string | null

The slug of the doc that holds it, for a brief, copy or other piece. Its title and body are the doc's, as they are now

lead*object | null

A brief on a lead: the title and the body are its email, and POST /drafts/{id}/send sends it

8 properties
to*string

The email of the lead

name*string | null
company*string | null
fit*integer

How well the lead fits who the business sells to, from 1 to 10

why*string

Why that score

angle*string | null

The reason to write to this lead

brief*string

Who they are and why they fit, in markdown

sent*boolean

The email went from Troopy

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

personagentapi

id*string
name*string
decidedAt*string | null
createdAt*string

ISO 8601 date and time

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