Drip campaign settings

Change one setting of a drip campaign at a time, and read how it is doing. The settings calls need the send_sms permission and refuse test keys (403 test_key_not_allowed). An id that isn’t a whole number answers 400 invalid_id, and one that isn’t a drip campaign on your account answers 404 DRIP_NOT_FOUND.

#Rename a drip campaign

Changes the drip’s name. Returns {"success": true}.

Parameters

idinteger, pathRequired: The drip campaign id.
namestringRequired: The new name, up to 120 characters. Spaces around it are trimmed.

Errors

HTTP	Code	When
400	`invalid_field`	No name, a blank one, or one over 120 characters.
500	`DRIP_RENAME_WRITE_FAILED`	It wasn’t renamed. Try again.

curl -X PUT "https://api.tryready.com/drip-campaigns/57/rename" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New lead follow-up (spring)"
  }'

const res = await fetch('https://api.tryready.com/drip-campaigns/57/rename', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "New lead follow-up (spring)"
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.put(
    "https://api.tryready.com/drip-campaigns/57/rename",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "name": "New lead follow-up (spring)"
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

#Set a drip’s sending hours

Sets the hours and days the drip may text, and its time zone. Send only what you change: a field you leave out keeps its saved value, and one you send as null or "" is cleared. Send all four as null to clear the window. With no window the drip texts at any hour quiet hours allow. A text that comes due outside the window waits for the next opening. Returns the saved values in data.

Parameters

idinteger, pathRequired: The drip campaign id.
delivery_window_startstring: 24 hour time like 08:30.
delivery_window_endstring: 24 hour time like 17:00, later than the start.
delivery_window_daysstring: Comma separated days from mon, tue, wed, thu, fri, sat, sun. Other words are dropped.
timezonestring: An IANA name such as America/Los_Angeles. Cleared or never set, the drip uses America/New_York. This zone also reads a start_at with no zone when you add contacts.

Errors

HTTP	Code	When
400	`invalid_field`	A time that isn’t like `08:30`, or a zone name that isn’t shaped like one.
400	`DRIP_WINDOW_ORDER`	The end is the same as the start, or before it. Windows that run overnight aren’t supported.
400	`DRIP_TIMEZONE_INVALID`	A zone we don’t know, such as `Pacific Time` or `PDT`.
500	`DRIP_WINDOW_SAVE_FAILED`	Nothing was changed. Try again.

curl -X PUT "https://api.tryready.com/drip-campaigns/57/delivery-window" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "delivery_window_start": "09:00",
    "delivery_window_end": "17:00",
    "delivery_window_days": "mon,tue,wed,thu,fri",
    "timezone": "America/Chicago"
  }'

const res = await fetch('https://api.tryready.com/drip-campaigns/57/delivery-window', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "delivery_window_start": "09:00",
    "delivery_window_end": "17:00",
    "delivery_window_days": "mon,tue,wed,thu,fri",
    "timezone": "America/Chicago"
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.put(
    "https://api.tryready.com/drip-campaigns/57/delivery-window",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "delivery_window_start": "09:00",
        "delivery_window_end": "17:00",
        "delivery_window_days": "mon,tue,wed,thu,fri",
        "timezone": "America/Chicago"
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "delivery_window_start": "09:00",
    "delivery_window_end": "17:00",
    "delivery_window_days": "mon,tue,wed,thu,fri",
    "timezone": "America/Chicago"
  }
}

#Turn Smart Scheduling on or off

Smart Scheduling moves each step after the first toward the hour the contact usually replies, up to 12 hours later. Returns {"success": true}.

Parameters

idinteger, pathRequired: The drip campaign id.
enabledbooleanRequired: true or false. "false" and 0 also mean off.

Errors

HTTP	Code	When
400	`BAD_SHAPE`	`enabled` is missing or isn’t on or off.
500	`DRIP_SMART_SEND_SAVE_FAILED`	Nothing was changed. Try again.

curl -X PUT "https://api.tryready.com/drip-campaigns/57/smart-send" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true
  }'

const res = await fetch('https://api.tryready.com/drip-campaigns/57/smart-send', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "enabled": true
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.put(
    "https://api.tryready.com/drip-campaigns/57/smart-send",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "enabled": True
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

#Set a drip’s sending number

Picks the number the drip texts from: one of your numbers, several of them, or neither (Automatic), so your account picks as it does for any text. A number that has since stopped working is passed over at send time, never a reason to drop a text. Returns the saved phone_number_id and from_phone_ids in data.

Parameters

idinteger, pathRequired: The drip campaign id.
phone_number_idinteger: The id of one of your numbers that can send.
from_phone_idsinteger[]: Or several of your number ids to send from. These win over phone_number_id, and only the ids that can send are kept. Send neither to go back to your account’s choice.

Errors

HTTP	Code	When
400	`DRIP_FROM_NUMBER_NOT_USABLE`	The number isn’t yours or can’t send, or none of the numbers you picked can. Nothing was changed.
500	`DRIP_FROM_NUMBER_SAVE_FAILED`	Nothing was changed. Try again.

curl -X PUT "https://api.tryready.com/drip-campaigns/57/from-number" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number_id": 12
  }'

const res = await fetch('https://api.tryready.com/drip-campaigns/57/from-number', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "phone_number_id": 12
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.put(
    "https://api.tryready.com/drip-campaigns/57/from-number",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "phone_number_id": 12
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "phone_number_id": 12,
    "from_phone_ids": null
  }
}

#Drip campaign results

These calls only read. A team member limited to their assigned contacts sees only those contacts' rows in the logs and lists.

#Get results per step

For each step: texts sent, delivered and failed, how many contacts texted back before this drip’s next text to them, how many of those opted out, and how many contacts are waiting at it now. Returns one row per step in data.

Returns

data[]object[]: step, sent, delivered, failed, replied, opted_out, waiting, and delivery_rate: delivered out of delivered plus failed, as a percent, or null before any result.
delivery_ratenumber or null: The same for the whole drip.
partialboolean: true on a very large drip whose reply counts took too long: replied and opted_out read 0; sent, delivered, failed and waiting are filled in.

Errors

HTTP	Code	When
500	`DRIP_STEP_STATS_LOAD_FAILED`	We couldn’t read them. Try again.

curl "https://api.tryready.com/drip-campaigns/57/step-stats" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/drip-campaigns/57/step-stats', {
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/drip-campaigns/57/step-stats",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": [
    {
      "step": 1,
      "sent": 400,
      "delivered": 388,
      "failed": 4,
      "replied": 61,
      "opted_out": 5,
      "waiting": 12,
      "delivery_rate": 99
    }
  ],
  "delivery_rate": 99
}

#List a drip’s sent texts

The texts this drip sent, newest first. Each row has id, direction, body, status, sent_at, created_at, the contact’s first_name, last_name and phone, and error_detail, a plain reason when it failed.

Parameters

idinteger, pathRequired: The drip campaign id.
limitinteger, queryDefault 100: From 1 to 300. There is no paging: this is the newest texts only.

Errors

HTTP	Code	When
500	`DRIP_ACTIVITY_LOAD_FAILED`	We couldn’t read them. Texts may still have gone out.

curl "https://api.tryready.com/drip-campaigns/57/logs?limit=50" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/drip-campaigns/57/logs?limit=50', {
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/drip-campaigns/57/logs?limit=50",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

#List who is scheduled on a day

The active contacts whose next step is due on one day, in the drip’s time zone (America/New_York when it has none), soonest first. Returns date, total, limit, offset and contacts (each contact_id, current_step, next_send_at, first_name, last_name, phone) in data.

Parameters

idinteger, pathRequired: The drip campaign id.
datestring, queryRequired: The day, like 2027-01-05.
limitinteger, queryDefault 100: From 1 to 500.
offsetinteger, queryDefault 0: How many to skip.

Errors

HTTP	Code	When
400	`DATE_REQUIRED`	No `date`, or not a real day.
500	`DRIP_SCHEDULE_LOAD_FAILED`	We couldn’t read it. Try again.

curl "https://api.tryready.com/drip-campaigns/57/scheduled?date=2027-01-05&limit=100" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/drip-campaigns/57/scheduled?date=2027-01-05&limit=100', {
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/drip-campaigns/57/scheduled?date=2027-01-05&limit=100",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

#Get active contacts per rep

How many active contacts in the drip each team member is assigned, and the daily cap each is held to. Returns sequence (id, name, status, daily_cap, daily_cap_mode), cap_summary (a sentence) and assignees (each assignee_id, name, email, active_enrollments, daily_cap) in data. Unassigned contacts have assignee_id: null; a daily_cap of null is no cap.

Errors

HTTP	Code	When
500	`DRIP_BREAKDOWN_LOAD_FAILED`	We couldn’t read it. Try again.

curl "https://api.tryready.com/drip-campaigns/57/assignee-breakdown" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/drip-campaigns/57/assignee-breakdown', {
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/drip-campaigns/57/assignee-breakdown",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

#Get the schedule per rep

Sends due in the next 14 days, per assigned team member, busiest first. Each row has assigned_to (null for unassigned contacts), name, total and days, one {date, count} per day with sends.

Errors

HTTP	Code	When
500	`DRIP_SCHEDULE_LOAD_FAILED`	We couldn’t read it. Try again.

curl "https://api.tryready.com/drip-campaigns/57/schedule-by-assignee" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/drip-campaigns/57/schedule-by-assignee', {
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/drip-campaigns/57/schedule-by-assignee",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')