Resources / Support Articles / API
Getting Started
For API integration, the only requirement is having basic programming skills. We designed PreviewMyEmail to be an easy-to-integrate service. A programmer with moderate skills can integrate PreviewMyEmail API within appr. 10-15 minutes.
PreviewMyEmail API uses the easiest API protocol called HTTP REST. This means that with a basic HTTP connection to our API, you can delivery your emails.
API Connection URL
You will need to use the following URL to pass parameters to PreviewMyEmail API:
http://previewmyemail.com/api/
API Error Codes
- 2000
Provided API key is invalid. - 2001
The requested API command is only available for monthly unlimited plan users. - 2002
Preview request not found - 2003
Preview couldn’t be deleted - 2004
Preview results couldn’t be deleted - 2005
Not enough tredits to perform your request - 2006
Email client not found - 3000
Missing or incorrect email content type. It should be ‘HTML’ or ‘Text’ - 3001
Missing email content - 3002
Missing request ID - 3003
Thumbnail request not found. Incorrect request ID - 3004
Thumbnail is not available yet. Please check again later - 3005
Rate limit exceeded. We have limits per hour. Please try again next hour.
Example Success API Response
The following response is an example to show you what kind of data will be returned back upon a successful API call:
[{"available_credits":"Unlimited"}]
Example Error API Response
The following response is an example to show you what kind of data will be returned back once an error occurs:
[{"Success":"false","ErrorCode":2000,"ErrorReason":"Invalid APIKey"}]