Legacy migration guide

Move from the legacy REST and HTTP APIs to the current EZ Texting API: what changes in your code, and which endpoint replaces each legacy call.

This guide is for integrations built on the legacy REST API, the legacy HTTP API, or the legacy incoming message forwarding. It lists what changes in your code and which current endpoint replaces each legacy call.

The current API is a full rebuild. It adds OAuth 2.0, contact upserts and batch updates, conversations, templates, message reports, and webhooks. The legacy APIs are no longer actively maintained; their reference pages stay available under Legacy docs.


What changes in your code

LegacyCurrent
Base URLhttps://app.eztexting.comhttps://a.eztexting.com/v1/
AuthenticationREST API: HTTP Basic Auth. HTTP API: User and Password request parameters.HTTP Basic Auth or OAuth 2.0 bearer tokens, in the Authorization header only. → Authentication
Format?format=json or ?format=xml; form-encoded request bodiesJSON request and response bodies only. Send Content-Type: application/json and drop format.
Phone numbers10 digits (2135551234)Most formats accepted; store and send 11 digits, country code first (12135551234). → Phone number formatting
Sending to groupsGroup names in Groups[]Group IDs in groupIds. Look IDs up with GET /v1/contact-groups.
SchedulingStampToSend as YYYY-MM-DD HH:MM:SSsendAt as ISO 8601 with a UTC offset (2026-11-20T09:00:00-08:00)
ContactsIdentified by contact ID; separate create and update callsIdentified by phone number; one upsert call creates or updates. → Core concepts
Incoming messagesEZ Texting sends a GET to a URL you configure, and can text back your HTTP responseSigned JSON webhooks. Replies are separate POST /v1/messages calls. → Webhooks
ErrorsJSON or XML error, or numeric return codes (HTTP API)Standard HTTP status codes with a JSON error body. → Errors
Rate limitNot published200 requests per minute per account. → Rate limits

Sending a message: before and after

Legacy REST API:

curl -u "$USERNAME:$PASSWORD" -X POST "https://app.eztexting.com/sending/messages?format=json" \
  -d "PhoneNumbers[]=2135551234" \
  -d "Message=Your order has shipped" \
  -d "MessageTypeID=1"

Current API:

curl -X POST https://a.eztexting.com/v1/messages \
  -u "$EZTEXTING_USERNAME:$EZTEXTING_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"toNumbers": ["12135551234"], "message": "Your order has shipped"}'
Legacy parameterCurrent fieldNotes
PhoneNumberstoNumbersArray of phone numbers. Use 11 digits.
GroupsgroupIdsGroup IDs, not names.
MessagemessageUp to 160 characters per SMS segment; longer text is split or sent as MMS. → Core concepts
Subject—No equivalent. Put the text in message.
MessageTypeID—No equivalent; drop it. The optional messageType (SMS or MMS) chooses the format instead.
StampToSendsendAtISO 8601 with a UTC offset.
MediaFileIDmediaFileIdOr pass a public mediaUrl.
fromNumberNew. Choose which of your numbers sends the message.
companyNameNew. The same as the web app's Subject field: your business name, shown in parentheses before the text.
messageTemplateIdNew. Send a saved template.
strictValidationNew, and on by default: if any number is invalid, nothing is sent and you get a 400. Set it to false to skip bad numbers instead, which is closer to legacy behavior.

Endpoint mapping

Legacy paths below are from the Legacy REST API. The legacy HTTP API's send, credit, and keyword calls map to the same current endpoints.

Messages and reports

TaskLegacy REST APICurrent API
Send a messagePOST /sending/messagesPOST /v1/messages
Delivery report summaryGET /sending/reportsGET /v1/message-reports/{id}
Recipients by delivery statusGET /sending/reports/{status}GET /v1/message-reports/{id}/responses/delivery with filters[status][eq]
Scheduled and sent campaigns—GET /v1/campaign-info
Cancel a scheduled message—DELETE /v1/messages

Inbox → conversations

The current API organizes inbound and outbound texts into conversations: one thread per contact and sending number.

TaskLegacy REST APICurrent API
List inbox messagesGET /incoming-messagesGET /v1/conversations, or GET /v1/messages with filters[incoming][eq]=true
Read one threadGET /incoming-messages/{id}GET /v1/conversations/conversation/USERNUMBER/{contactNumber}
Delete a messageDELETE /incoming-messages/{id}DELETE /v1/messages
Mark read or unread—POST /v1/conversations/messages/read and …/unread
Move a message to a folderPUT /incoming-messagesNo folders. Archive or restore the conversation instead.
Create, update, list, or delete folders/incoming-messages/foldersNo equivalent

Keywords

TaskLegacy REST APICurrent API
Check availabilityGET /keywords/{keyword}GET /v1/keywords/{keyword}/check
Rent a keywordPOST /keywords/{keyword}POST /v1/keywords/{keyword}/acquire
Configure a keywordPUT /keywords/{keyword}PUT /v1/keywords/{keyword}
Cancel a keywordDELETE /keywords/{keyword}DELETE /v1/keywords/{keyword}/release
List your keywords—GET /v1/keywords

Credits

TaskLegacy REST APICurrent API
Check balanceGET /billing/credits/getGET /v1/credits
Buy creditsPOST /billing/creditsPOST /v1/credits/purchase

Contacts

TaskLegacy REST APICurrent API
List contactsGET /contactsGET /v1/contacts
Get one contactGET /contacts/{id}GET /v1/contacts/{phoneNumber}
Create a contactPOST /contactsPOST /v1/contacts (creates or updates)
Update a contactPUT /contacts/{id}POST /v1/contacts (creates or updates)
Create or update many—POST /v1/contacts/batch
Delete a contactDELETE /contacts/{id}DELETE /v1/contacts/{phoneNumber}

Groups

TaskLegacy REST APICurrent API
List groupsGET /groupsGET /v1/contact-groups
Get one groupGET /groups/{id}GET /v1/contact-groups/{id}
Create a groupPOST /groupsPOST /v1/contact-groups
Update a groupPUT /groups/{id}PUT /v1/contact-groups/{id}
Delete a groupDELETE /groups/{id}DELETE /v1/contact-groups/{id}
Add or remove contacts—POST or DELETE /v1/contact-groups/{id}/contacts

Media files

TaskLegacy REST APICurrent API
List media filesGET /media-filesGET /v1/media-files
Get one media fileGET /media-files/{id}GET /v1/media-files/{id}
Upload a media filePOST /media-filesPOST /v1/media-files
Delete a media fileDELETE /media-files/{id}DELETE /v1/media-files/{id}

Incoming message forwarding → webhooks

LegacyCurrent
Keyword submission forwarded to your URL as a GETkeyword.opt_in webhook
Inbox reply forwarded to your URL as a GETinbound_text.received webhook
"Wait for response from my server" texts back your HTTP responseNo equivalent. Reply with POST /v1/messages from your handler.
—contact.created webhook (new)

Webhooks send JSON in a signed POST. Verify the signature and store the event before you respond. → Webhooks

Not available in the current API

  • Inbox folders. Use conversation archiving instead.
  • Voice broadcast (legacy HTTP API).
  • Carrier lookup (legacy HTTP API, already deprecated).

Migration checklist

  • Switch the base URL to https://a.eztexting.com/v1/ and send JSON with Content-Type: application/json.
  • Move credentials into the Authorization header. Use OAuth 2.0 tokens in production.
  • Convert stored phone numbers to 11 digits.
  • Replace group names with group IDs.
  • Convert scheduled times to ISO 8601 with a UTC offset.
  • Replace contact IDs with phone numbers as the contact key.
  • Replace forwarding URLs with webhook subscriptions, and send replies with POST /v1/messages.
  • Handle 429 responses using the retry header.
  • Test with a group that contains only your team. → Testing your integration

Related


Did this page help you?