Esendex
Esendex messaging API integration and workflow automation
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.esendex.com/v1.0 | link | — | — | — |
Actions (48)
SMS API · 19
- Create AccountPOST /v1.0/accounts
Create a new Esendex account with optional label.
documented - Delete Inbox MessageDELETE /v1.0/inbox/messages/{id}
Delete a message from the inbox.
documented - List AccountsGET /v1.0/accounts
Retrieve a summary of Esendex accounts accessible by the user.
documented - List Inbox MessagesGET /v1.0/inbox/{accountReference}/messages
Retrieve inbox messages for an account.
documented - List Message DispatcherGET /v1.0/messagedispatcher
List available Message Dispatcher resources.
documented - List Message HeadersGET /v1.0/messageheaders
Retrieve a list of message headers for the authenticated account.
documented - List Message Headers by Date RangeGET /v1.0/messageheaders?start={start}&finish={finish}
Retrieve headers for messages sent within a date range.
documented - List Message Headers by OriginatorGET /v1.0/messageheaders?from={originator}
Retrieve headers for messages sent from a particular originator.
documented - List Message Headers by RecipientGET /v1.0/messageheaders?to={phone}&start={start}&finish={finish}
Retrieve headers for messages sent to a particular recipient.
documented - List Message Headers by StatusGET /v1.0/messageheaders?status=Delivered
Retrieve headers filtered by status.
documented - Mark Inbox Message as ReadPUT /v1.0/inbox/messages/{id}?action=read
Mark an inbox message as read.
documented - Mark Inbox Message as UnreadPUT /v1.0/inbox/messages/{id}?action=unread
Mark an inbox message as unread.
documented - Retrieve AccountGET /v1.0/accounts/{account_id}
Return details for a specific Esendex account.
documented - Retrieve Account SettingsGET /v1.0/accounts/{account_id}/settings
Retrieve settings for an Esendex account.
documented - Retrieve Message BodyGET /v1.0/messageheaders/{id}/body
Retrieve the full body of a specific message header.
documented - Retrieve Message HeaderGET /v1.0/messageheaders/{id}
Retrieve the details of a specific message header.
documented - Send Message (Dispatcher)POST /v1.0/messagedispatcher
Submit a message for sending via the Message Dispatcher (XML payload).
documented - Update AccountPUT /v1.0/accounts/{account_id}
Update details for an account (e.g., label).
documented - Update Account SettingsPUT /v1.0/accounts/{account_id}/settings
Update settings for an Esendex account.
documented
Contacts API · 12
- Add Contact to GroupPOST /v2.0/contactgroups/{id}/contacts
Add a contact to a contact group.
documented - Create ContactPOST /v2.0/contacts
Create a new contact.
documented - Create Contact GroupPOST /v2.0/contactgroups
Create a new contact group.
documented - Delete ContactDELETE /v2.0/contacts/{id}
Delete a contact.
documented - Delete Contact GroupDELETE /v2.0/contactgroups/{id}
Delete a contact group.
documented - List Contact GroupsGET /v2.0/contactgroups
Retrieve all contact groups for an account.
documented - List ContactsGET /v2.0/contacts
Retrieve a paged list of contacts for an account.
documented - List Contacts in GroupGET /v2.0/contactgroups/{id}/contacts
List members of a contact group.
documented - Retrieve ContactGET /v2.0/contacts/{id}
Retrieve a single contact by ID.
documented - Retrieve Contact GroupGET /v2.0/contactgroups/{id}
Retrieve a single contact group by ID.
documented - Update ContactPUT /v2.0/contacts/{id}
Update an existing contact.
documented - Update Contact GroupPUT /v2.0/contactgroups/{id}
Update an existing contact group.
documented
FormPost API · 9
- Delete Inbox MessageGET /secure/messenger/formpost/DeleteInboxMessage.aspx
Delete an inbox message via FormPost API.
documented - Get Inbox MessageGET /secure/messenger/formpost/GetInboxMessage.aspx
Retrieve inbox messages via FormPost API.
documented - Get Inbox Message (FormPost)GET /secure/messenger/formpost/GetInboxMessage.aspx
Retrieve inbox messages via FormPost.
documented - Get Latest Inbox MessagesGET /secure/messenger/formpost/GetLatestInboxMessages.aspx
Retrieve latest inbox messages via FormPost API.
documented - Query Status (FormPost)GET /secure/messenger/formpost/QueryStatus.aspx
Query the status of a submitted message via FormPost API.
documented - Schedule SMS (FormPost)POST /secure/messenger/formpost/ScheduledSendSMS.aspx
Schedule an SMS to be sent later using the FormPost API.
documented - Send SMS (FormPost)POST /secure/messenger/formpost/SendSMS.aspx
Send an SMS using the FormPost API.
documented - Send WAP Push SMS (FormPost)POST /secure/messenger/formpost/SendWapPushSMS.aspx
Send a WAP Push SMS using the FormPost API.
documented - Stop Subscription (FormPost)GET /secure/messenger/formpost/StopSubscription.aspx
Stop a mobile subscription via FormPost API.
documented
Rich Content API · 6
- Create webhook subscriptionPOST /webhooks/v1/accounts/{accountReference}/subscriptions
Create a subscription to receive webhook events for a product.
documented - Get Rich Content Message StatusGET /richcontent/v3/accounts/{AccountReference}/messages/{GatewayId}
Retrieve the delivery/status information for a previously submitted rich content message.
documented - List webhook subscriptionsGET /webhooks/v1/accounts/{accountReference}/subscriptions
List existing webhook subscriptions for the account.
documented - Remove webhook subscriptionDELETE /webhooks/v1/accounts/{accountReference}/subscriptions/{productId}/{eventId}
Stop receiving webhook events for the specified product/event.
documented - Send Rich Content MessagePOST /richcontent/v3/send
Submit a rich content message to be delivered across supported channels.
documented - Send Rich Content Message (WhatsApp supported)POST /richcontent/v3/send
Submit a rich content message with channel WhatsApp to a recipient.
documented