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
| Legacy | Current | |
|---|---|---|
| Base URL | https://app.eztexting.com | https://a.eztexting.com/v1/ |
| Authentication | REST 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 bodies | JSON request and response bodies only. Send Content-Type: application/json and drop format. |
| Phone numbers | 10 digits (2135551234) | Most formats accepted; store and send 11 digits, country code first (12135551234). → Phone number formatting |
| Sending to groups | Group names in Groups[] | Group IDs in groupIds. Look IDs up with GET /v1/contact-groups. |
| Scheduling | StampToSend as YYYY-MM-DD HH:MM:SS | sendAt as ISO 8601 with a UTC offset (2026-11-20T09:00:00-08:00) |
| Contacts | Identified by contact ID; separate create and update calls | Identified by phone number; one upsert call creates or updates. → Core concepts |
| Incoming messages | EZ Texting sends a GET to a URL you configure, and can text back your HTTP response | Signed JSON webhooks. Replies are separate POST /v1/messages calls. → Webhooks |
| Errors | JSON or XML error, or numeric return codes (HTTP API) | Standard HTTP status codes with a JSON error body. → Errors |
| Rate limit | Not published | 200 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 parameter | Current field | Notes |
|---|---|---|
PhoneNumbers | toNumbers | Array of phone numbers. Use 11 digits. |
Groups | groupIds | Group IDs, not names. |
Message | message | Up 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. |
StampToSend | sendAt | ISO 8601 with a UTC offset. |
MediaFileID | mediaFileId | Or pass a public mediaUrl. |
fromNumber | New. Choose which of your numbers sends the message. | |
companyName | New. The same as the web app's Subject field: your business name, shown in parentheses before the text. | |
messageTemplateId | New. Send a saved template. | |
strictValidation | New, 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
| Task | Legacy REST API | Current API |
|---|---|---|
| Send a message | POST /sending/messages | POST /v1/messages |
| Delivery report summary | GET /sending/reports | GET /v1/message-reports/{id} |
| Recipients by delivery status | GET /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.
| Task | Legacy REST API | Current API |
|---|---|---|
| List inbox messages | GET /incoming-messages | GET /v1/conversations, or GET /v1/messages with filters[incoming][eq]=true |
| Read one thread | GET /incoming-messages/{id} | GET /v1/conversations/conversation/USERNUMBER/{contactNumber} |
| Delete a message | DELETE /incoming-messages/{id} | DELETE /v1/messages |
| Mark read or unread | — | POST /v1/conversations/messages/read and …/unread |
| Move a message to a folder | PUT /incoming-messages | No folders. Archive or restore the conversation instead. |
| Create, update, list, or delete folders | /incoming-messages/folders | No equivalent |
Keywords
| Task | Legacy REST API | Current API |
|---|---|---|
| Check availability | GET /keywords/{keyword} | GET /v1/keywords/{keyword}/check |
| Rent a keyword | POST /keywords/{keyword} | POST /v1/keywords/{keyword}/acquire |
| Configure a keyword | PUT /keywords/{keyword} | PUT /v1/keywords/{keyword} |
| Cancel a keyword | DELETE /keywords/{keyword} | DELETE /v1/keywords/{keyword}/release |
| List your keywords | — | GET /v1/keywords |
Credits
| Task | Legacy REST API | Current API |
|---|---|---|
| Check balance | GET /billing/credits/get | GET /v1/credits |
| Buy credits | POST /billing/credits | POST /v1/credits/purchase |
Contacts
| Task | Legacy REST API | Current API |
|---|---|---|
| List contacts | GET /contacts | GET /v1/contacts |
| Get one contact | GET /contacts/{id} | GET /v1/contacts/{phoneNumber} |
| Create a contact | POST /contacts | POST /v1/contacts (creates or updates) |
| Update a contact | PUT /contacts/{id} | POST /v1/contacts (creates or updates) |
| Create or update many | — | POST /v1/contacts/batch |
| Delete a contact | DELETE /contacts/{id} | DELETE /v1/contacts/{phoneNumber} |
Groups
| Task | Legacy REST API | Current API |
|---|---|---|
| List groups | GET /groups | GET /v1/contact-groups |
| Get one group | GET /groups/{id} | GET /v1/contact-groups/{id} |
| Create a group | POST /groups | POST /v1/contact-groups |
| Update a group | PUT /groups/{id} | PUT /v1/contact-groups/{id} |
| Delete a group | DELETE /groups/{id} | DELETE /v1/contact-groups/{id} |
| Add or remove contacts | — | POST or DELETE /v1/contact-groups/{id}/contacts |
Media files
| Task | Legacy REST API | Current API |
|---|---|---|
| List media files | GET /media-files | GET /v1/media-files |
| Get one media file | GET /media-files/{id} | GET /v1/media-files/{id} |
| Upload a media file | POST /media-files | POST /v1/media-files |
| Delete a media file | DELETE /media-files/{id} | DELETE /v1/media-files/{id} |
Incoming message forwarding → webhooks
| Legacy | Current |
|---|---|
Keyword submission forwarded to your URL as a GET | keyword.opt_in webhook |
Inbox reply forwarded to your URL as a GET | inbound_text.received webhook |
| "Wait for response from my server" texts back your HTTP response | No 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 withContent-Type: application/json. - Move credentials into the
Authorizationheader. 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
429responses using the retry header. - Test with a group that contains only your team. → Testing your integration
Related
- Quickstart: send your first message with the current API
- Core concepts
- Webhooks
- Legacy docs: reference for the legacy APIs
Try Troubleshooting, check status.eztexting.com, or contact support.
Updated 2 days ago