Legacy endpoints · Ready Docs

#Legacy endpoints

Still supported. New integrations should use the other endpoints in this reference.

#Send a message (older path)

POST/sms/send

The same send as POST /v1/messages, with the text in message.

Idempotent Yes, with Idempotency-Key
Rate limit Paced to your carrier throughput; 6,000/min ceiling
Cost Same as a send

Body parameters

toE.164 stringRequired: Recipient. A 10-digit US number is treated as +1.
messagestringRequired: The text. Same length limits as body on /v1/messages.
consent_attestedbooleanRequired: Your promise that this recipient agreed to get texts from you.
Details
Enforced the same way as on /v1/messages: required, not refused yet.
fromE.164 stringOptional: One of your numbers.
Details
Unlike /v1/messages, a number that isn't on your account is ignored here and Ready picks one.
from_phone_number_idintegerOptional: Send from this number id instead (the phone_number_id from a purchase).
from_strategyenumOptionalDefault local: local, even (or deliverability) or random. Ignored when from_phone_number_id is set.
media_urlstringOptional: As on /v1/messages.
confirm_empty_mergebooleanOptional: As on /v1/messages.
conversation_idintegerOptional: As on /v1/messages.
quoted_message_idintegerOptional: As on /v1/messages.
override_quiet_hoursbooleanOptional: As on /v1/messages.

Errors

HTTP	Code	When
400	no code	`to` missing, or no `message` and no `media_url`.
400	`MESSAGE_TOO_LONG`	Too long.
402	`insufficient_balance`	Balance too low.
4xx, 5xx	others	As on POST /v1/messages, except `invalid_from`.

POST /sms/send

curl -X POST "https://api.tryready.com/sms/send" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+12125550199",
    "message": "Your order #1042 has shipped.",
    "consent_attested": true
  }'

const res = await fetch('https://api.tryready.com/sms/send', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    "to": "+12125550199",
    "message": "Your order #1042 has shipped.",
    "consent_attested": true
  }),
});
const json = await res.json();
if (!res.ok || json.success === false) {
  throw new Error(`${res.status} ${json.error_code || json.code}: ${json.error}`);
}

import os, uuid, requests

r = requests.post(
    "https://api.tryready.com/sms/send",
    headers={"X-API-Key": os.environ["READY_API_KEY"], "Idempotency-Key": str(uuid.uuid4())},
    json={
        "to": "+12125550199",
        "message": "Your order #1042 has shipped.",
        "consent_attested": True
    },
    timeout=30,
)
data = r.json()
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code")}: {data.get("error")}')

Response

{
  "success": true,
  "data": {
    "message_id": "179088672338905475132359",
    "segments": 1,
    "sent_body": "Your order #1042 has shipped. Reply STOP to opt out. -Acme Co",
    "compliance_text_added": "Reply STOP to opt out. -Acme Co",
    "status": "queued",
    "sent_at": "2026-10-01T20:32:03.473Z",
    "sent_at_unix": 1790886723,
    "credits_remaining": 4823,
    "carrier_fee": 0.0045,
    "balance_usd": 118.42,
    "carrier_balance": 118.4215
  }
}

#Message log (dashboard)

GET/sms/logs

The dashboard's message log. Use GET /v1/messages instead: rows here are raw and can change.

Cost Free

Query parameters

limitintegerOptionalDefault 50Max 1000: Page size.
offsetintegerOptionalDefault 0: Rows to skip.
directionenumOptional: inbound or outbound. Anything else returns no rows, with no error.
statusstringOptional: Internal values: sent, pending, delivered, failed, received. queued matches nothing here.
searchstringOptional: A number or message text. Text searches cover only your most recent 10,000 messages.

Returns

data[]object[]: Message rows, without the message_id a send returned.
Details
Stable fields: id (integer), direction, from_number, to_number, body, status, segments, cost, created_at, delivered_at.
hasMoreboolean: camelCase here. total is always null.

Errors

HTTP	Code	When
500	no code	The log couldn't be loaded. Retry.

GET /sms/logs

curl "https://api.tryready.com/sms/logs?direction=outbound&limit=50" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/sms/logs?direction=outbound&limit=50', {
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json();
if (!res.ok || json.success === false) {
  throw new Error(`${res.status} ${json.error_code || json.code}: ${json.error}`);
}

import os, requests

r = requests.get(
    "https://api.tryready.com/sms/logs",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    params={
        "direction": "outbound",
        "limit": 50
    },
    timeout=30,
)
data = r.json()
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code")}: {data.get("error")}')

Response

{
  "success": true,
  "data": [
    {
      "id": 19292894,
      "direction": "outbound",
      "from_number": "+14155550100",
      "to_number": "+12125550199",
      "body": "Your order #1042 has shipped.",
      "status": "delivered",
      "segments": 1,
      "cost": 0.0245,
      "created_at": "2026-10-01T20:32:03.473Z",
      "delivered_at": "2026-10-01T20:32:09.856Z",
      "…": "…"
    }
  ],
  "hasMore": true,
  "total": null
}