Our WEB API gives you the possibility to send your campaigns with a single HTTP request as well as the ability to fully customize it.
Steps to take
- Make sure you have an active Inboxroad account. It can be created here.
- Obtain an API token. See next chapter.
- Start sending your emails!
Step 1: Obtain your token
You can obtain your API token in two ways: directly through the Inboxroad dashboard or via API request.
To get a token via an API request, you send a POST request to the following endpoint:
https://webapi.inboxroad/com/api/token
We have an interactive page where you can send your request.
The payload for the request should be JSON:
{
"username": "string",
"password":"string"
}All fields are required.
Examples:
<Code snippets>
Step 2: Sending a message
You need a token to send a message. This can be done by following he above steps.
The token should be provided as an Authorization header with the following format:
Basic <your_token_here>
To send a message provide a POST request with a JSON payload for the endpoint:
https://webapi.inboxroad.com/api/v1/messages/
The payload should be in the following format:
{
"from_email": "user@example.com",
"from_name": "string",
"to_email": "user@example.com",
"to_name": "string",
"reply_to_email": "user@example.com",
"reply_to_name": "string",
"subject": "string",
"text": "string",
"headers": {},
"html": "string",
"attachments": [
{
"filename": "string",
"mime_type": "string",
"file_data": "base64_string"
}
]}
Required fields
| Field name | Description |
| from_email | string – a valid email like string that represents the sender |
| to_email | string – a valid email like string that represents the receiver |
| text | string – a text field that contains the body of the message. If ‘html’ is empty this field is required |
| html | string – a html formatted string field that contains the HTML template of the email. If ‘text’ is empty this field is required. |
Examples:
<Code snippets>
Step 3: Start sending your emails
You are reading to send emails! On this page we provide a warm up schedule, so you can start building your sender’s reputation.
Contact us if you need help
Details about our API can be found on our interactive page. Please reach out to our support team if you need help.
