Skip to main content
POST
Start a Citedy warm-lead report

Authorizations

Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
domain
string
required

One company domain. Bare domains and http(s) URLs are accepted, but paths/social profile URLs are rejected.

Required string length: 1 - 253
icp
enum<string>

Ideal customer profile. Defaults to content-led-saas when omitted.

Available options:
seo-geo-agency,
content-led-saas,
vertical-saas
buyerRoles
string[]
Maximum array length: 6
Required string length: 1 - 80
maxContacts
integer

Maximum buyer candidates. Defaults to 3 when omitted.

Required range: 1 <= x <= 3
drafts
integer

Maximum outreach drafts. Defaults to 3 when omitted.

Required range: 1 <= x <= 3
freshnessDays
integer

Evidence lookback window in days. Defaults to 90 when omitted.

Required range: 7 <= x <= 365
idempotencyKey
string
Required string length: 8 - 128

Response

Existing idempotent warm-lead run returned without a new credit charge

run
object
required
credits_charged
integer
required
Required range: x >= 0
idempotent
boolean