API Documentation


What is a SaaS application without an API? Exactly, boring. The API makes it super easy to integrate ForwardMX with your other applications. Whether you want to create new aliases for new hires automatically, or want to offer your users email redirects as white label solution the API got you covered.


Unofficial libraries Clojure by @ianjs


GET/POST /api/domains

Returns a list of all your domains with aliases

key required Your API Key (Login and see your account page)
[  
   {  
      "domain":"example.com",
      "created_at":"2017-01-16T15:38:36.853Z",
      "status":"new",
      "aliases":[  
         {  
            "source":"@",
            "destination":"[email protected]",
            "count": 200
         }
      ]
   }
]
GET/POST /api/aliases

Returns a list of all your domains with aliases

key required Your API Key (Login and see your account page)
domain required A domain you want the aliases for
[  
   {  
      "source":"@",
      "destination":"[email protected]",
      "count": 521
   }
]
GET/POST /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 /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 /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 @ for catch all, or any string without domain
destination required A email address the messages should be forwarded to
{ok: "$Message"}
{error: "$Message"}
GET/POST /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 string without domain you want to change
destination required A email address the messages should be forwarded to
{ok: "$Message"}
{error: "$Message"}
GET/POST /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"}

Other Knowledge Database articles

Use Zapier to send Emails to Slack Using ForwardMX with Godaddy Using ForwardMX with Namecheap