API documentation

The API allows you to access all Mailrelay.com features using Json. Although the examples provided on this manual are in PHP, you can use any language to access our API.

If you're using Ruby, check our Gem available in https://rubygems.org/gems/mailrelay. For more information and examples, check here.

JSON

Json API is located at:

https://your_address/ccm/admin/api/version/2/&type=json

For the Json API, you must always send a parameter called "function" to specify which function you're calling.

Rate limit

Our API apply rate limits to requests. There are a few reasons why you might be getting an error message indicating that you've sent too many requests:

  • You're using functions like addSubscriber or updateSubscriber to import a large number of subscribers. We recommend using import function which is prepared to handle large amounts of data.
  • You're using functions like sendMail or sendCampaignTest to send a lot of individual emails. We recommend using our SMTP service which is prepared to handle this type of job.

If the above cases doesn't apply to you. Please, contact us and provide more information about you issue. We will gladly work with you to provide a solution.

Menu Title