Legacy Migration Guide
EZ Texting's current REST API delivers enhanced security and improved functionality that provides more customization and personalization to your SMS workflows.
The legacy HTTP API and legacy REST API are no longer supported. If you rely on either of these, please migrate to the new REST API to avoid disruption with your EZ Texting services.
Rebuilt from the ground up, the new EZ Texting API delivers new features and enhanced security to provide improved customization and personalization to your SMS workflows. Incorporate seamless integrations using our simple API to automate and scale your business.
What's new in the REST API v1
- Basic Auth and OAuth2 support
- Contact creation and contact update have been consolidated into a single method, simplifying contact management workflows
- Optional “from number” parameter can be defined when generating 1:1 messages to send from any number that exists in the account
- Batched contact creation and update
- Event notifications via webhooks
Benefits of moving to the new API
- Improved Security — With basic auth and OAuth2 token-based authentication, we provide API security you can trust to grow and scale functionality within your workflows.
- Faster Response Times — Our new API helps increase overall customer satisfaction with optimized performance. We know speed is essential to your organization.
- High Availability & Limited Downtime — You can count on the new API to perform at a gold standard.
- Continued Feature Improvement — We will continue to release enhancements and improve capabilities.
Endpoint migration tables
The tables below will help you migrate from the HTTP API or Legacy REST API to the new REST API v1.
Send Message & Reporting
View in API Reference →
| Legacy HTTP API | Legacy REST API | New REST API |
|---|
| Send / Create Message | https://app.eztexting.com/api/sending/ | https://app.eztexting.com/sending/messages?format=format | https://a.eztexting.com/v1/messages |
| Delivery Reports | N/A | https://app.eztexting.com/sending/reports/ID/?format=format | https://a.eztexting.com/v1/message-reports/{id} |
| Detailed Delivery Report | N/A | https://app.eztexting.com/sending/reports/ID/view-details/?format=format&status=status | https://a.eztexting.com/v1/message-reports/{id}/responses/delivery |
Inbox / Conversation Management
View in API Reference →
| Legacy HTTP API | Legacy REST API | New REST API |
|---|
| Delete Message | N/A | https://app.eztexting.com/incoming-messages/ID?format=format | https://a.eztexting.com/v1/messages |
| Get all Messages | N/A | https://app.eztexting.com/incoming-messages?format=format | https://a.eztexting.com/v1/messages |
| Get One Message | N/A | https://app.eztexting.com/incoming-messages/ID?format=format | https://a.eztexting.com/v1/messages |
| Move Message to a Folder | N/A | https://app.eztexting.com/incoming-messages/?format=format&_method=move-... | N/A |
| Create Folder | N/A | https://app.eztexting.com/messages-folders?format=format | N/A |
| Update Folder | N/A | https://app.eztexting.com/messages-folders/ID?format=format | N/A |
| Delete Folder | N/A | https://app.eztexting.com/messages-folders/ID?format=format | N/A |
| Get all Folders | N/A | https://app.eztexting.com/messages-folders?format=format | N/A |
| Get a Folder | N/A | https://app.eztexting.com/messages-folders/ID?format=format | N/A |
Keywords
View in API Reference →
| Legacy HTTP API | Legacy REST API | New REST API |
|---|
| Check Availability | https://app.eztexting.com/api/keyword/check/ | https://app.eztexting.com/keywords/new?Keyword=keyword&format=format | https://a.eztexting.com/v1/keywords/{keyword}/check |
| Rent a Keyword | https://app.eztexting.com/api/keyword/rent/ | https://app.eztexting.com/keywords?format=format | https://a.eztexting.com/v1/keywords/{keyword}/acquire |
| Setup a Keyword | https://app.eztexting.com/api/keyword/setup/ | https://app.eztexting.com/keywords/keyword?format=format | https://a.eztexting.com/v1/keywords/{keyword} |
| Cancel a Keyword | N/A | https://app.eztexting.com/keywords/keyword?format=format | https://a.eztexting.com/v1/keywords/{keyword}/release |
Credits
| Legacy HTTP API | Legacy REST API | New REST API |
|---|
| Check Credit Balance | N/A | https://app.eztexting.com/billing/credits/get?format=format | https://a.eztexting.com/v1/credits |
| Purchase Credits | https://app.eztexting.com/api/credits/buy/ | https://app.eztexting.com/billing/credits?format=format | https://a.eztexting.com/v1/credits/purchase |
Contacts
View in API Reference →
| Legacy HTTP API | Legacy REST API | New REST API |
|---|
| Create Contact | N/A | https://app.eztexting.com/contacts?format=format | https://a.eztexting.com/v1/contacts |
| Update Contact | N/A | https://app.eztexting.com/contacts/ID?format=format | https://a.eztexting.com/v1/contacts |
| Delete Contact | N/A | https://app.eztexting.com/contacts/ID?format=format | https://a.eztexting.com/v1/contacts/phoneNumber |
| Get all Contacts | N/A | https://app.eztexting.com/contacts?format=format | https://a.eztexting.com/v1/contacts |
| Get one Contact | N/A | https://app.eztexting.com/contacts/ID?format=format | https://a.eztexting.com/v1/contacts/phoneNumber |
Groups
View in API Reference →
| Legacy HTTP API | Legacy REST API | New REST API |
|---|
| Create a Group | N/A | https://app.eztexting.com/groups?format=format | https://a.eztexting.com/v1/contact-groups |
| Update a Group | N/A | https://app.eztexting.com/groups/ID?format=format | https://a.eztexting.com/v1/contact-groups/{id} |
| Delete a Group | N/A | https://app.eztexting.com/groups/ID?format=format | https://a.eztexting.com/v1/contact-groups/id |
| Get all Groups | N/A | https://app.eztexting.com/groups?format=format | https://a.eztexting.com/v1/contact-groups |
| Get one Group | N/A | https://app.eztexting.com/groups/ID?format=format | https://a.eztexting.com/v1/contact-groups/{id} |
Media Files
View in API Reference →
| Legacy HTTP API | Legacy REST API | New REST API |
|---|
| Get all Media Files | N/A | https://app.eztexting.com/sending/files?format=format | https://a.eztexting.com/v1/media-files |
| Get one File | N/A | https://app.eztexting.com/sending/files/ID?format=format | https://a.eztexting.com/v1/media-files/{id} |
| Create Media File | N/A | https://app.eztexting.com/sending/files?format=format | https://a.eztexting.com/v1/media-files |
| Delete Media File | N/A | https://app.eztexting.com/sending/files/ID?format=format | https://a.eztexting.com/v1/media-files/{id} |
Need help migrating? Contact our support team at
eztexting.com/support for assistance, or explore the full
API Reference to see all available endpoints with interactive examples.