Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.botdog.co/llms.txt

Use this file to discover all available pages before exploring further.

1. Get an API key

Create or copy an API key from the Botdog dashboard. Keys are prefixed with bd_live_.

2. List campaigns

curl -sS -H "x-api-key: YOUR_API_KEY" \
  "https://YOUR_API_HOST/v1/campaigns"
const res = await fetch('https://YOUR_API_HOST/v1/campaigns', {
  headers: { 'x-api-key': process.env.BOTDOG_API_KEY },
});
const campaigns = await res.json();

3. Create a lead

Replace CAMPAIGN_ID with a campaign id from the previous step.
curl -sS -X POST "https://YOUR_API_HOST/v1/campaigns/CAMPAIGN_ID/leads" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"leads":[{"email":"hello@example.com","firstName":"Ada"}]}'

4. Check analytics

curl -sS -H "x-api-key: YOUR_API_KEY" \
  "https://YOUR_API_HOST/v1/analytics/summary"
Use the API Reference tab for full request and response schemas. Prefer no-code automation? See the Zapier integration guide.