leads

Add leads to a campaign

Add leads to an existing campaign. Batch operation — up to 100 leads at a time.

post/v1/leads/add_to_campaign

Request

  • Base URL: https://api.botdog.co
  • URL: https://api.botdog.co/v1/leads/add_to_campaign
  • Auth: API key in header x-api-key

Request body

campaignIdstring required

The campaign ID to add these leads to

Example request

{
  "campaignId": "123e4567-e89b-12d3-a456-426614174000",
  "leads": [
    {
      "name": "John Doe",
      "linkedinUrl": "https://www.linkedin.com/in/johndoe",
      "title": "Software Engineer",
      "company": "Acme Inc.",
      "location": "San Francisco, CA",
      "customAttributes": {
        "customKey1": "customValue1",
        "customKey2": "customValue2"
      }
    }
  ]
}

Response

The leads have been successfully added to the campaign

countnumber required

The number of leads successfully created

campaignIdstring required

The campaign ID the leads were added to

Example response

{
  "count": 50,
  "campaignId": "123e4567-e89b-12d3-a456-426614174000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.