API reference / CRM
Add to do-not-contact
Puts an email address or a whole domain on do-not-contact: no campaign enrolls or writes to it again, and the leads it matches stop at once. Adding one already there changes nothing.
post
/api/v1/do-not-contactOther ways to call it
CLI
troopy dnc addMCP tool
troopy_add_do_not_contactRate 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/jsonvalue*stringAn email address, or a domain like acme.com
At least 3 characters · At most 254 characters
reasonstringAt most 200 characters
Response
201 · application/jsondata*object8 properties
id*stringA 24-character id
kind*enum<string>emaildomainlinkedin
label*string | nullThe address, domain or profile; null once its person was forgotten
cause*enum<string>manualunsubscribedbouncednot_interestedforgotten
reason*stringby*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
stopped*integerLeads it stopped
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.