Leads

Sync add leads to campaign

Adds up to 100 existing account people to a campaign by global_lead_id. Emits one lead.added_to_campaign.completed batch webhook.

POST/v1/campaigns/{id}/leads:add

Authorization

bearerAuth

AuthorizationBearer <token>

Use an account API key in the Authorization header: Authorization: Bearer f_....

In: header

Path Parameters

idstring

Campaign id.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

global_lead_idsarray<string>

Items1 <= items <= 100

curl -X POST "https://example.com/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/leads:add" \  -H "Content-Type: application/json" \  -d '{    "global_lead_ids": [      "string"    ]  }'

{  "data": {    "created": 0,    "updated": 0,    "enrolled": 0,    "skipped": 0,    "incomplete": 0,    "failed": 0,    "errors": [      {        "globalLeadId": "string",        "message": "string"      }    ]  }}

{  "error": {    "type": "invalid_request_error",    "code": "invalid_flow",    "message": "Flow validation failed"  },  "details": [    {      "path": "nodes[1].data.variants[0].id",      "code": "invalid_variant_id",      "message": "Email variants must have a stable UUID id."    }  ]}

{  "error": {    "type": "authentication_error",    "code": "invalid_api_key",    "message": "A valid Furnace API key is required"  }}

{  "error": {    "type": "permission_error",    "code": "smartlead_read_only",    "message": "Smartlead campaigns are read-only via the API"  }}

{  "error": {    "type": "invalid_request_error",    "code": "campaign_not_found",    "message": "Campaign not found"  }}

{  "error": {    "type": "rate_limit_error",    "code": "rate_limit_exceeded",    "message": "Rate limit exceeded for this account"  }}

{  "error": {    "type": "api_error",    "code": "internal_error",    "message": "Internal server error"  }}