API reference / Outreach
Enroll leads in a campaign
Enrolls leads from the campaign's list: the rows named, or everyone its filters keep (all), at most 1,000 a call. A lead needs an email a check said reaches them, or with risky also one not checked or not certain; never one that doesn't, and never anyone on do-not-contact. Their first emails in fixed words are drafted at once.
post
/api/v1/campaigns/{id}/enrollOther ways to call it
CLI
troopy campaigns enrollMCP toolNone. Call it over REST or with the CLI.
Rate limit30 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*stringA 24-character id
Body
application/jsonrowsarray<string>Rows of the campaign's list
At most 1000 items
allbooleanEveryone on the list its filters keep
riskybooleanAlso leads whose email no check said reaches them
Response
200 · application/jsondata*object2 properties
enrolled*integerskipped*object5 properties
noEmail*integerunverified*integerinvalid*integerdoNotContact*integeralready*integerErrors
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.