readyDocs Open the app

API changelog

#Changes by date

Changes to what the public API and webhooks accept or send, newest first. A change that removes or alters something is listed here with its date before it ships. We only add fields, events and error codes within /v1; see Versioning for the notice we give.

  • 2026-11-21, removed. accept_partner_terms and partner_terms_sha256 on POST /v1/sub-accounts. The Partner Terms change who pays for your clients, so the account owner accepts them in the app; an API key can no longer accept them. A call that sends accept_partner_terms: true before they are accepted answers 403 partner_terms_browser_only and creates nothing. Once accepted in the app, billing: "client" works as before. See Create a sub-account.
  • 2026-11-21, added. On GET /v1/messages and GET /v1/messages/:id, a text Ready held before sending (blocked: true) carries in blocked_reason the code POST /v1/messages answers for that refusal, such as number_disconnected, opt_out_locked or quiet_hours, where it said other before. error_reason stays blocked_before_send, and a check with no code of its own is still other. See blocked_reason.
  • 2026-11-21, removed. POST /v1/registration/:id/vet and /vet/confirm no longer return the carrier’s raw vetting response field. It was deprecated and documented as not to parse, and no API key had called these routes. Use success, and read the brand’s vetting with GET /v1/registration.
  • 2026-11-21, added. GET /v1/registration/denied answers with a Deprecation: true header and a Link header (rel="successor-version") to GET /v1/registration, which carries rejection_reason, rejection_detail and rejection_suggested_fix. There is no Sunset: the path keeps working.
  • 2026-11-21, changed. From January 20, 2027 (UTC), a text sent with an API key, or through Zapier or n8n with one, and without consent_attested: true is refused with 403 api_consent_attested_required, and nothing is sent or charged. Until then these sends still go through, and the answer carries a warnings list, a Warning header and Deprecation and Sunset headers that name the date. Add consent_attested: true to your send now. See Send a message.
  • 2026-11-21, changed. Refusals on /v1/sub-accounts, /v1/team-members, /v1/white-label and /v1/partner/clients keep the extra fields other /v1 refusals carry, such as field on 400 invalid_request and permission on 403 permission_denied. POST /v1/sub-accounts states its length limits (email 254, first name, last name and company name 120 each): an over-long field was already refused, and now the sentence and field name it.
  • 2026-11-21, changed. An API key can no longer sign the white label agreement, pay the Platform Fee or decline a held client sign-up (POST /agency/brand/agreement, /agency/brand/fee and /agency/join-link/waiting/:id/deny, dashboard paths these pages never listed): 403 api_key_not_allowed. Do these on the Partner page.
  • 2026-11-21, added. POST /sms/send called with an API key answers with a Deprecation: true header and a Link header (rel="successor-version") to POST /v1/messages, as GET /sms/logs already does. There is no Sunset: the path keeps working, and the body doesn’t change.
  • 2026-11-21, changed. GET /drip-campaigns (and /drip-sequences) no longer sends a drip’s consent_attested_ip, consent_attested_user_agent or attested_by_staff_id, which were never documented; consent_attested_at and consent_attested_text still come back. Its live counts (enrolled_count, queued_now and the rest) are integers, as documented. Before, they came back as strings.
  • 2026-11-21, added. A missed call to one of your numbers is already told apart in the call webhooks and in GET /v1/calls: call_completed carries status: "missed" and outcome: "missed". Nothing new is sent. To text the caller back, turn on missed call text back for the number or use the A call is missed trigger in Automations. See Missed call text back.
  • 2026-11-20, added. GET /v1/messages/:id also answers id, the message’s public id, the same value GET /v1/messages lists. message_id still echoes the id you asked with.
  • 2026-11-20, added. A send through POST /v1/messages from your iMessage line also answers status: "queued", to and from beside message_id (still a number) and channel.
  • 2026-11-20, changed. confirm_empty_merge and hold_until_allowed take the string "true" as well as true on POST /v1/messages, POST /sms/send and each recipient of POST /v1/messages/bulk, as override_quiet_hours already did. Before, "true" was read as off.
  • 2026-11-20, changed. On the Twilio-shaped send (POST /2010-04-01/Accounts/{AccountSid}/Messages.json), a merge field that is empty for the recipient answers 400 with ready_code: "empty_merge_field". Before, it answered 200 with the error body. 202 send_outcome_unknown is unchanged.
  • 2026-11-20, changed. GET /sms/my-delivery-rate accepts provider=sms and answers filters.provider: "sms". The value it took before still filters the same, and is now echoed as sms.
  • 2026-11-20, added. Signed account webhooks also carry X-Ready-Timestamp and X-Ready-Signature-V2. The older signature header is unchanged. See Webhooks.
  • 2026-11-20, added. Each top error in the deliverability report carries error_reason, the same stable code GET /v1/messages/{id} gives.
  • 2026-11-20, added. Call reports have a /v1 home, /v1/reports/calls, with their own page in the docs.
  • 2026-11-20, added. GET /settings/webhooks/deliveries answers 503 search_timed_out when a search runs too long. Add the event, result or sub_account_id filter and search again.
  • 2026-11-20, changed. /zapier refusals that had only a sentence now carry a code in error_code and code: the sub-account picker answers 400 invalid_workspace, 403 workspace_not_allowed, 503 workspaces_unavailable and 404 workspace_action_unsupported, and a stale dropdown page link answers 400 invalid_cursor. The status and the message are the same.
  • 2026-11-20, changed. GET /v1/reports/hourly answers count, delivered and failed as integers, and GET /v1/reports/volume answers date as YYYY-MM-DD and count and delivered as integers on every window, as documented. Before, the hourly counts and some daily windows (a UTC account asking for a custom range) came back as strings such as "120" and a date as 2026-10-30T00:00:00.000Z.
  • 2026-11-20, changed. An API key can no longer remove a sub-account (DELETE /sub-accounts/:id, a dashboard path these pages never listed): 403 api_key_not_allowed. Remove one from Sub-accounts in the dashboard.
  • 2026-11-20, changed. POST /v1/calls answers 409 scrub_list for a lead on a federal or state Do Not Call or litigator list your account scrubs against. Before, a match on only a Do Not Call list answered 409 opted_out. The message is new; the status is the same. Calls to a number that opted out still answer opted_out.
  • 2026-11-20, changed. /tasks refusals carry a code beside the same message: task_not_found, title_required, contact_not_found, assignee_not_found, invalid_due_date, task_changed, tasks_unavailable, task_delete_failed, offset_not_supported and cursor_expired.
  • 2026-11-20, changed. The 400 for the managed Opted Out tag on POST /contacts/bulk-tag and DELETE /contacts/tags/:tag carries code: "reserved_tag", and an unreadable filters carries invalid_filters. The messages are the same.
  • 2026-11-20, changed. /custom-fields refusals carry a code beside the same message (name_required, name_invalid, name_taken, assigned_only, custom_fields_unavailable, too_many_fields, value_too_long). Nothing else about them changed.
  • 2026-11-20, changed. MCP: send_sms, delete_contact, send_campaign, update_campaign, resume_campaign, stop_campaign, delete_campaign, enroll_in_drip, create_campaign with scheduled_at, and update_drip_status to active no longer run over MCP, for OAuth and API key callers alike. They change nothing and answer isError with the Ready page where a person does it. Tool names and input schemas are the same. serverInfo.version is now 1.1.0.
  • 2026-11-19, changed. A number’s health_score now drops from the first text spam report: 1 report scores 60, 2 score 20, 3 or more score 0. Before, one report still scored 100. See Number health.
  • 2026-11-19, changed. POST /zapier/subscribe refuses a new http:// target_url with 400 target_url_invalid. An existing http subscription keeps working.
  • 2026-11-19, removed. GET and PUT /v1/imessage-lines/auto-add, and the auto_add field on the iMessage line checkout and buy calls. Ready no longer buys a line on its own; no account had it turned on. These now answer 404 NOT_FOUND. To add a line, buy one.
  • 2026-11-15, changed. The message_id on iMessage message_delivered, message_failed and imessage_tapback webhooks now starts im:, where it started zs: before. Lines carried by the other iMessage provider send br: ids. Treat the whole value as an opaque string: its prefix can change, and a change is listed here first. If you stored zs: ids from earlier deliveries, match on the part after the colon.
  • 2026-11-14, changed. POST /v1/sub-accounts with billing left out (so client, the default) answers 409 partner_terms_required until the Partner Terms are accepted, and 409 white_label_pays_for_clients for a white label agency. Send billing: "agency", or accept_partner_terms: true on the call. Before, the create went through. See Create a sub-account.
  • 2026-11-14, changed. /v1/validate answers area code 555, premium numbers (900, 976) and the 555-0100 to 555-0199 range with valid: false and the reasons restricted_number or fictional_number, not looked up and not billed. Before, they were looked up and answered with a line type.
  • 2026-11-14, changed. POST and PUT /custom-fields accept only text, number, date or dropdown as field_type (any capitalisation); any other value answers 400 invalid_field. Before, it was saved as given.
  • 2026-11-14, changed. GET /v1/opt-outs accepts scope=all, which adds your ban list after your opted-out contacts. Without it the answer is the same as before.
  • 2026-11-14, removed. The 402 MONTHLY_CAP_REACHED body from POST /v1/messages and POST /sms/send no longer carries window_days. It was never documented. The cap fields cap, count and block_ends_at are unchanged.
  • 2026-11-14, removed. GET and PUT /v1/auto-vet (automatic paid vetting; it never ran for any account). They now answer 404 NOT_FOUND. Vet a registration by hand with /vet/checkout and /vet/confirm.
  • 2026-11-13, changed. A Canadian order (country: "CA") on checkout and buy reads area_code: a Canadian code is ordered, and any other code answers 400 area_code_invalid. Before, area_code was ignored on a non-US order.
  • 2026-11-11, changed. Registration statuses are spelled cancelled. Stored canceled values were rewritten to match; a registration that read canceled before now reads cancelled.
  • 2026-11-11, changed. GET /v1/opt-outs needs the view_contacts permission; a key without it answers 403 permission_denied.
  • 2026-11-11, changed. POST /campaigns/:id/ai-analyze and GET /campaigns/:id/breakdown need the view_reports permission. Every built-in role has view_reports; a custom role without it gets 403 from these routes.
  • 2026-11-11, changed. An API key can no longer turn on iMessage line auto-add or cancel a paid iMessage line: 403 api_key_not_allowed. Use the dashboard.
  • 2026-11-09, changed. GET /v1/opt-outs/:phone answers opted_out: true for a number opted out on any account in your agency, not only your own.
  • 2026-11-08, changed. PUT /v1/webhooks answers 400 invalid_event and saves nothing when events holds a name Ready doesn’t send. Before, it answered 200 and dropped the unknown name.
  • 2026-11-02, changed. An API key can no longer change scrub settings (POST /compliance/scrub-categories and the other settings writes): 403 owner_signed_in_only. Use the dashboard.
  • 2026-11-02, changed. GET /mcp/authorize requires a scope parameter; without one it answers 400 invalid_scope.
  • 2026-11-02, changed. An API key can no longer open a dashboard session or change a team seat’s or client account’s login email: 403 api_key_not_allowed.
  • 2026-11-02, changed. A key rejected from the X-API-Key header answers 401 INVALID_API_KEY. Before, it answered 401 INVALID_TOKEN (the code for an ended sign-in session). The status is the same; branch on INVALID_API_KEY.
  • 2026-11-01, changed. /v1/opt-outs routes are rate limited, so a key that calls them in a tight loop can get 429 rate_limited. A phone number of 8 or 9 digits answers 400 invalid_number.
  • 2026-10-26, removed. MCP tools create_ai_agent, update_ai_agent, set_ai_agent_status, test_ai_agent, ai_compose_campaign and diagnose_campaign. A call to one answers an unknown-tool error.