API Documentation

ForwardMX has a fully featured API that is available on all account tiers, allowing you to add/update/delete domains and aliases from your applications.

It uses HTTP GET or HTTP POST with standard form field elements to receive the data, and returns a JSON object.

We also have a WordPress plugin and Ruby Gem, as well as an unofficial Clojure library from ianjs.

GET/POST https://forwardmx.io/api/domains/

Returns a list of all your domains

key required Your API Key (Login and see your account page)
[  
   {  
      "domain":"example.com",
      "status":"active"
   }
]
GET/POST https://forwardmx.io/api/aliases/

Returns a list of all aliases for a domain

key required Your API Key (Login and see your account page)
domain required A domain you want the aliases for
[  
   {  
      "source":"@",
      "destination":"[email protected]",
   }
]
GET/POST https://forwardmx.io/api/domain/create/

Create a new domain on your account

key required Your API Key (Login and see your account page)
domain required A domain you want to add to your account
{"ok": "$Message"}
{"error": "$Message"}
GET/POST https://forwardmx.io/api/domain/destroy/

Destroy a domain from your account

key required Your API Key (Login and see your account page)
domain required A domain you want to destroy
{"ok": "$Message"}
{"error": "$Message"}
GET/POST https://forwardmx.io/api/alias/create/

Create a new alias entry on your account/domain

key required Your API Key (Login and see your account page)
domain required A domain on which you want to edit the alias
alias required Any username without @domain
destination required A email address the messages should be forwarded to
{"ok": "$Message"}
{"error": "$Message"}
GET/POST https://forwardmx.io/api/alias/update/

Update a alias entry on your domain

key required Your API Key (Login and see your account page)
domain required A domain on which you want to edit the alias
alias required @ for catch all, or any username without @domain you want to change
destination required A email address the messages should be forwarded to
{"ok": "$Message"}
{"error": "$Message"}
GET/POST https://forwardmx.io/api/alias/destroy/

Destroy a alias from your account/domain

key required Your API Key (Login and see your account page)
domain required A domain on which you want to edit the alias
alias required Alias source you want to remove
{"ok": "$Message"}
{"error": "$Message"}

Writing and deleting operations all return either as hash with ok: message, or error: message.

{"ok": "$Message"}
{"error": "$Message"}

Was this answer helpful? 0 Users Found This Useful (0 Votes)