Skip to main content
POST
/
v1
/
leads
/
add_to_campaign
Add leads to campaign
curl --request POST \
  --url https://api.botdog.io/v1/leads/add_to_campaign \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "campaignId": "123e4567-e89b-12d3-a456-426614174000",
  "leads": [
    {
      "linkedinUrl": "https://www.linkedin.com/in/johndoe",
      "name": "John Doe",
      "title": "Software Engineer",
      "company": "Acme Inc.",
      "location": "San Francisco, CA",
      "customAttributes": {
        "customKey1": "customValue1",
        "customKey2": "customValue2"
      }
    }
  ]
}
'
{
  "count": 50,
  "campaignId": "123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

x-api-key
string
header
default:bd_live_your_key_here
required

Body

application/json
campaignId
string
required

The campaign ID to add these leads to

Example:

"123e4567-e89b-12d3-a456-426614174000"

leads
object[]
required

Array of leads to create (maximum 100)

Response

The leads have been successfully added to the campaign

count
number
required

The number of leads successfully created

Example:

50

campaignId
string
required

The campaign ID the leads were added to

Example:

"123e4567-e89b-12d3-a456-426614174000"