Skip to main content
POST
/
api
/
agent
/
citedy-warm-lead
Start a Citedy warm-lead report
curl --request POST \
  --url https://www.citedy.com/api/agent/citedy-warm-lead \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "buyerRoles": [
    "<string>"
  ],
  "maxContacts": 2,
  "drafts": 2,
  "freshnessDays": 186,
  "idempotencyKey": "<string>"
}
'
{
  "run": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "domain": "<string>",
    "normalized_domain": "<string>",
    "credits_charged": 1,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "blocked_reason": "<string>",
    "error_message": "<string>",
    "result": {
      "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account": {},
      "signals": [
        {}
      ],
      "contacts": [
        {}
      ],
      "scoring": {},
      "drafts": [
        {}
      ],
      "policy": {},
      "counters": {},
      "exportRows": [
        {}
      ],
      "exportUrls": {}
    },
    "provider_counters": {},
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "credits_charged": 1,
  "idempotent": true
}

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