Campaigns

Bulk outbound calling over a list of recipients.

List campaigns

GET/campaigns

GET /campaigns

curl -X GET "https://api.rabbitt.ai/api/v1/campaigns" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

GET /campaigns

const response = await fetch("https://api.rabbitt.ai/api/v1/campaigns", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
  },
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

GET /campaigns

import os
import requests

response = requests.get(
    "https://api.rabbitt.ai/api/v1/campaigns",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
)
response.raise_for_status()
data = response.json()

Query parameters

statusstringoptional

agentIdstringoptional

pageintegeroptional

default: 1 · min 1

limitintegeroptional

default: 25 · 1–100

Responses

200A paginated list of campaigns

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

429Rate limit exceeded

Response body - 200

objectstring

dataTypestring

dataobject[]

paginationobject

Create a campaign

POST/campaigns

Campaigns start in `draft`. Add recipients, then call `POST /campaigns/{id}/launch`.

POST /campaigns

curl -X POST "https://api.rabbitt.ai/api/v1/campaigns" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Asha Menon",
    "agentId": "507f1f77bcf86cd799439011"
  }'

POST /campaigns

const response = await fetch("https://api.rabbitt.ai/api/v1/campaigns", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Asha Menon",
    "agentId": "507f1f77bcf86cd799439011"
  }),
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

POST /campaigns

import os
import requests

response = requests.post(
    "https://api.rabbitt.ai/api/v1/campaigns",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
    json={
        "name": "Asha Menon",
        "agentId": "507f1f77bcf86cd799439011"
    },
)
response.raise_for_status()
data = response.json()

Body parameters

namestringrequired

max length 200

descriptionstringoptional

max length 1000

agentIdstringrequired

timezonestringoptional

max length 64

settingsobjectoptional

retryLimitintegeroptional

1–5

retryDelayMinutesintegeroptional

1–10080

concurrencyintegeroptional

1–25

Responses

201The created campaign

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

409A campaign with this name already exists

429Rate limit exceeded

Response body - 201

idstring

objectstring

namestring

descriptionstring

agentIdstring

agentNamestring

statusstring

One of:draftscheduledrunningpausedcompletedcancelledarchived

timezonestring

settingsobject

retryLimitinteger

retryDelayMinutesinteger

concurrencyinteger

statsobject

totalinteger

pendinginteger

completedinteger

failedinteger

launchedAttimestamp

pausedAttimestamp

completedAttimestamp

createdAttimestamp

Retrieve a campaign

GET/campaigns/{id}

GET /campaigns/{id}

curl -X GET "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

GET /campaigns/{id}

const response = await fetch("https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
  },
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

GET /campaigns/{id}

import os
import requests

response = requests.get(
    "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
)
response.raise_for_status()
data = response.json()

Path parameters

idstringrequired

Responses

200The campaign

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

429Rate limit exceeded

Response body - 200

idstring

objectstring

namestring

descriptionstring

agentIdstring

agentNamestring

statusstring

One of:draftscheduledrunningpausedcompletedcancelledarchived

timezonestring

settingsobject

retryLimitinteger

retryDelayMinutesinteger

concurrencyinteger

statsobject

totalinteger

pendinginteger

completedinteger

failedinteger

launchedAttimestamp

pausedAttimestamp

completedAttimestamp

createdAttimestamp

Update a campaign

PATCH/campaigns/{id}

Only campaigns in `draft` or `paused` can be edited.

PATCH /campaigns/{id}

curl -X PATCH "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Asha Menon",
    "description": "…",
    "timezone": "…",
    "settings": {}
  }'

PATCH /campaigns/{id}

const response = await fetch("https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Asha Menon",
    "description": "…",
    "timezone": "…",
    "settings": {}
  }),
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

PATCH /campaigns/{id}

import os
import requests

response = requests.patch(
    "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
    json={
        "name": "Asha Menon",
        "description": "…",
        "timezone": "…",
        "settings": {}
    },
)
response.raise_for_status()
data = response.json()

Path parameters

idstringrequired

Body parameters

namestringoptional

max length 200

descriptionstringoptional

max length 1000

timezonestringoptional

max length 64

settingsobjectoptional

Responses

200The updated campaign

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

429Rate limit exceeded

Response body - 200

idstring

objectstring

namestring

descriptionstring

agentIdstring

agentNamestring

statusstring

One of:draftscheduledrunningpausedcompletedcancelledarchived

timezonestring

settingsobject

retryLimitinteger

retryDelayMinutesinteger

concurrencyinteger

statsobject

totalinteger

pendinginteger

completedinteger

failedinteger

launchedAttimestamp

pausedAttimestamp

completedAttimestamp

createdAttimestamp

Launch a campaign

POST/campaigns/{id}/launch

POST /campaigns/{id}/launch

curl -X POST "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/launch" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

POST /campaigns/{id}/launch

const response = await fetch("https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/launch", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
  },
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

POST /campaigns/{id}/launch

import os
import requests

response = requests.post(
    "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/launch",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
)
response.raise_for_status()
data = response.json()

Path parameters

idstringrequired

Responses

200The campaign in its new state

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

409The campaign cannot make this transition from its current status

429Rate limit exceeded

Response body - 200

idstring

objectstring

namestring

descriptionstring

agentIdstring

agentNamestring

statusstring

One of:draftscheduledrunningpausedcompletedcancelledarchived

timezonestring

settingsobject

retryLimitinteger

retryDelayMinutesinteger

concurrencyinteger

statsobject

totalinteger

pendinginteger

completedinteger

failedinteger

launchedAttimestamp

pausedAttimestamp

completedAttimestamp

createdAttimestamp

Pause a campaign

POST/campaigns/{id}/pause

POST /campaigns/{id}/pause

curl -X POST "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/pause" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

POST /campaigns/{id}/pause

const response = await fetch("https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/pause", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
  },
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

POST /campaigns/{id}/pause

import os
import requests

response = requests.post(
    "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/pause",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
)
response.raise_for_status()
data = response.json()

Path parameters

idstringrequired

Responses

200The campaign in its new state

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

409The campaign cannot make this transition from its current status

429Rate limit exceeded

Response body - 200

idstring

objectstring

namestring

descriptionstring

agentIdstring

agentNamestring

statusstring

One of:draftscheduledrunningpausedcompletedcancelledarchived

timezonestring

settingsobject

retryLimitinteger

retryDelayMinutesinteger

concurrencyinteger

statsobject

totalinteger

pendinginteger

completedinteger

failedinteger

launchedAttimestamp

pausedAttimestamp

completedAttimestamp

createdAttimestamp

Resume a campaign

POST/campaigns/{id}/resume

POST /campaigns/{id}/resume

curl -X POST "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/resume" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

POST /campaigns/{id}/resume

const response = await fetch("https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/resume", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
  },
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

POST /campaigns/{id}/resume

import os
import requests

response = requests.post(
    "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/resume",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
)
response.raise_for_status()
data = response.json()

Path parameters

idstringrequired

Responses

200The campaign in its new state

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

409The campaign cannot make this transition from its current status

429Rate limit exceeded

Response body - 200

idstring

objectstring

namestring

descriptionstring

agentIdstring

agentNamestring

statusstring

One of:draftscheduledrunningpausedcompletedcancelledarchived

timezonestring

settingsobject

retryLimitinteger

retryDelayMinutesinteger

concurrencyinteger

statsobject

totalinteger

pendinginteger

completedinteger

failedinteger

launchedAttimestamp

pausedAttimestamp

completedAttimestamp

createdAttimestamp

Cancel a campaign

POST/campaigns/{id}/cancel

POST /campaigns/{id}/cancel

curl -X POST "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/cancel" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

POST /campaigns/{id}/cancel

const response = await fetch("https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
  },
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

POST /campaigns/{id}/cancel

import os
import requests

response = requests.post(
    "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/cancel",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
)
response.raise_for_status()
data = response.json()

Path parameters

idstringrequired

Responses

200The campaign in its new state

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

409The campaign cannot make this transition from its current status

429Rate limit exceeded

Response body - 200

idstring

objectstring

namestring

descriptionstring

agentIdstring

agentNamestring

statusstring

One of:draftscheduledrunningpausedcompletedcancelledarchived

timezonestring

settingsobject

retryLimitinteger

retryDelayMinutesinteger

concurrencyinteger

statsobject

totalinteger

pendinginteger

completedinteger

failedinteger

launchedAttimestamp

pausedAttimestamp

completedAttimestamp

createdAttimestamp

Archive a campaign

POST/campaigns/{id}/archive

POST /campaigns/{id}/archive

curl -X POST "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/archive" \
  -H "Authorization: Bearer rb_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

POST /campaigns/{id}/archive

const response = await fetch("https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/archive", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RABBITT_API_KEY}`,
  },
});

if (!response.ok) {
  const { error } = await response.json();
  throw new Error(`${error.code}: ${error.message}`);
}

const data = await response.json();

POST /campaigns/{id}/archive

import os
import requests

response = requests.post(
    "https://api.rabbitt.ai/api/v1/campaigns/507f1f77bcf86cd799439011/archive",
    headers={"Authorization": f"Bearer {os.environ['RABBITT_API_KEY']}"},
)
response.raise_for_status()
data = response.json()

Path parameters

idstringrequired

Responses

200The campaign in its new state

400Invalid request

401Missing or invalid API key

403The key lacks the required scope

404Resource not found

409The campaign cannot make this transition from its current status

429Rate limit exceeded

Response body - 200

idstring

objectstring

namestring

descriptionstring

agentIdstring

agentNamestring

statusstring

One of:draftscheduledrunningpausedcompletedcancelledarchived

timezonestring

settingsobject

retryLimitinteger

retryDelayMinutesinteger

concurrencyinteger

statsobject

totalinteger

pendinginteger

completedinteger

failedinteger

launchedAttimestamp

pausedAttimestamp

completedAttimestamp

createdAttimestamp