Start paid leads verification

POST /leads/verification/start

Authentication

Send your organization API key as a Bearer credential.

Authorization: Bearer YOUR_API_KEY

Body

application/json

Verification job parameters

campaign_id string required

UUID of the campaign whose not-yet-contacted leads should be verified.

Example: 550e8400-e29b-41d4-a716-446655440000

need_send_to_accept_all object

When true, leads with verification result "accept_all" stay sendable. When false (default), they are stopped from sending.

Example: false

Response

application/json

Verification job created and credits charged

purchased_credits number required

Number of credits charged for this verification job (0.5 credit per lead). Equal to leads.length * 0.5.

Example: 12.5

Request

curl --request POST \
  --url https://developer.coldy.ai/api/v1/leads/verification/start \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaign_id": "550e8400-e29b-41d4-a716-446655440000",
  "need_send_to_accept_all": false
}'

{
  "purchased_credits": 12.5
}

{
  "message": [
    "You put invalid API key. Verify your key with the key from your account in Coldy. Check documenation for info"
  ],
  "statusCode": 400,
  "error": "Invalid API key"
}