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_termsandpartner_terms_sha256onPOST /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 sendsaccept_partner_terms: truebefore they are accepted answers403 partner_terms_browser_onlyand creates nothing. Once accepted in the app,billing: "client"works as before. See Create a sub-account. - 2026-11-21, added. On
GET /v1/messagesandGET /v1/messages/:id, a text Ready held before sending (blocked: true) carries inblocked_reasonthe codePOST /v1/messagesanswers for that refusal, such asnumber_disconnected,opt_out_lockedorquiet_hours, where it saidotherbefore.error_reasonstaysblocked_before_send, and a check with no code of its own is stillother. Seeblocked_reason. - 2026-11-21, removed.
POST /v1/registration/:id/vetand/vet/confirmno 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. Usesuccess, and read the brand’s vetting with GET /v1/registration. - 2026-11-21, added.
GET /v1/registration/deniedanswers with aDeprecation: trueheader and aLinkheader (rel="successor-version") to GET /v1/registration, which carriesrejection_reason,rejection_detailandrejection_suggested_fix. There is noSunset: 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: trueis refused with403 api_consent_attested_required, and nothing is sent or charged. Until then these sends still go through, and the answer carries awarningslist, aWarningheader andDeprecationandSunsetheaders that name the date. Addconsent_attested: trueto your send now. See Send a message. - 2026-11-21, changed. Refusals on
/v1/sub-accounts,/v1/team-members,/v1/white-labeland/v1/partner/clientskeep the extra fields other/v1refusals carry, such asfieldon400 invalid_requestandpermissionon403 permission_denied.POST /v1/sub-accountsstates 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 andfieldname 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/feeand/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/sendcalled with an API key answers with aDeprecation: trueheader and aLinkheader (rel="successor-version") toPOST /v1/messages, asGET /sms/logsalready does. There is noSunset: 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’sconsent_attested_ip,consent_attested_user_agentorattested_by_staff_id, which were never documented;consent_attested_atandconsent_attested_textstill come back. Its live counts (enrolled_count,queued_nowand 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_completedcarriesstatus: "missed"andoutcome: "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/:idalso answersid, the message’s public id, the same valueGET /v1/messageslists.message_idstill echoes the id you asked with. - 2026-11-20, added. A send through
POST /v1/messagesfrom your iMessage line also answersstatus: "queued",toandfrombesidemessage_id(still a number) andchannel. - 2026-11-20, changed.
confirm_empty_mergeandhold_until_allowedtake the string"true"as well astrueonPOST /v1/messages,POST /sms/sendand each recipient ofPOST /v1/messages/bulk, asoverride_quiet_hoursalready 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 answers400withready_code: "empty_merge_field". Before, it answered200with the error body.202 send_outcome_unknownis unchanged. - 2026-11-20, changed.
GET /sms/my-delivery-rateacceptsprovider=smsand answersfilters.provider: "sms". The value it took before still filters the same, and is now echoed assms. - 2026-11-20, added. Signed account webhooks also carry
X-Ready-TimestampandX-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 codeGET /v1/messages/{id}gives. - 2026-11-20, added. Call reports have a
/v1home,/v1/reports/calls, with their own page in the docs. - 2026-11-20, added.
GET /settings/webhooks/deliveriesanswers503 search_timed_outwhen a search runs too long. Add theevent,resultorsub_account_idfilter and search again. - 2026-11-20, changed.
/zapierrefusals that had only a sentence now carry a code inerror_codeandcode: the sub-account picker answers400 invalid_workspace,403 workspace_not_allowed,503 workspaces_unavailableand404 workspace_action_unsupported, and a stale dropdown page link answers400 invalid_cursor. The status and the message are the same. - 2026-11-20, changed.
GET /v1/reports/hourlyanswerscount,deliveredandfailedas integers, andGET /v1/reports/volumeanswersdateasYYYY-MM-DDandcountanddeliveredas 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 as2026-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/callsanswers409 scrub_listfor 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 answered409 opted_out. The message is new; the status is the same. Calls to a number that opted out still answeropted_out. - 2026-11-20, changed.
/tasksrefusals carry acodebeside 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_supportedandcursor_expired. - 2026-11-20, changed. The
400for the managedOpted Outtag onPOST /contacts/bulk-tagandDELETE /contacts/tags/:tagcarriescode: "reserved_tag", and an unreadablefilterscarriesinvalid_filters. The messages are the same. - 2026-11-20, changed.
/custom-fieldsrefusals carry acodebeside 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_campaignwithscheduled_at, andupdate_drip_statustoactiveno longer run over MCP, for OAuth and API key callers alike. They change nothing and answerisErrorwith the Ready page where a person does it. Tool names and input schemas are the same.serverInfo.versionis now1.1.0. - 2026-11-19, changed. A number’s
health_scorenow 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/subscriberefuses a newhttp://target_urlwith400 target_url_invalid. An existinghttpsubscription keeps working. - 2026-11-19, removed.
GETandPUT /v1/imessage-lines/auto-add, and theauto_addfield 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 answer404 NOT_FOUND. To add a line, buy one. - 2026-11-15, changed. The
message_idon iMessagemessage_delivered,message_failedandimessage_tapbackwebhooks now startsim:, where it startedzs:before. Lines carried by the other iMessage provider sendbr:ids. Treat the whole value as an opaque string: its prefix can change, and a change is listed here first. If you storedzs:ids from earlier deliveries, match on the part after the colon. - 2026-11-14, changed.
POST /v1/sub-accountswithbillingleft out (soclient, the default) answers409 partner_terms_requireduntil the Partner Terms are accepted, and409 white_label_pays_for_clientsfor a white label agency. Sendbilling: "agency", oraccept_partner_terms: trueon the call. Before, the create went through. See Create a sub-account. - 2026-11-14, changed.
/v1/validateanswers area code 555, premium numbers (900, 976) and the 555-0100 to 555-0199 range withvalid: falseand the reasonsrestricted_numberorfictional_number, not looked up and not billed. Before, they were looked up and answered with a line type. - 2026-11-14, changed.
POSTandPUT /custom-fieldsaccept onlytext,number,dateordropdownasfield_type(any capitalisation); any other value answers400 invalid_field. Before, it was saved as given. - 2026-11-14, changed.
GET /v1/opt-outsacceptsscope=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_REACHEDbody fromPOST /v1/messagesandPOST /sms/sendno longer carrieswindow_days. It was never documented. The cap fieldscap,countandblock_ends_atare unchanged. - 2026-11-14, removed.
GETandPUT /v1/auto-vet(automatic paid vetting; it never ran for any account). They now answer404 NOT_FOUND. Vet a registration by hand with/vet/checkoutand/vet/confirm. - 2026-11-13, changed. A Canadian order (
country: "CA") on checkout and buy readsarea_code: a Canadian code is ordered, and any other code answers400 area_code_invalid. Before,area_codewas ignored on a non-US order. - 2026-11-11, changed. Registration statuses are spelled
cancelled. Storedcanceledvalues were rewritten to match; a registration that readcanceledbefore now readscancelled. - 2026-11-11, changed.
GET /v1/opt-outsneeds theview_contactspermission; a key without it answers403 permission_denied. - 2026-11-11, changed.
POST /campaigns/:id/ai-analyzeandGET /campaigns/:id/breakdownneed theview_reportspermission. Every built-in role hasview_reports; a custom role without it gets403from 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/:phoneanswersopted_out: truefor a number opted out on any account in your agency, not only your own. - 2026-11-08, changed.
PUT /v1/webhooksanswers400 invalid_eventand saves nothing wheneventsholds 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-categoriesand the other settings writes):403 owner_signed_in_only. Use the dashboard. - 2026-11-02, changed.
GET /mcp/authorizerequires ascopeparameter; without one it answers400 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-Keyheader answers401 INVALID_API_KEY. Before, it answered401 INVALID_TOKEN(the code for an ended sign-in session). The status is the same; branch onINVALID_API_KEY. - 2026-11-01, changed.
/v1/opt-outsroutes are rate limited, so a key that calls them in a tight loop can get429 rate_limited. A phone number of 8 or 9 digits answers400 invalid_number. - 2026-10-26, removed. MCP tools
create_ai_agent,update_ai_agent,set_ai_agent_status,test_ai_agent,ai_compose_campaignanddiagnose_campaign. A call to one answers an unknown-tool error.