Mailee Client v2
API to integrate your app with Mailee.me. You can automatically send email marketing campaigns, track its results and keep your contacts synced. We are still in beta. If you have any problems or suggestions, please contact us at [email protected]
Mailee Client v2 endpoints
| Method | Endpoint | Description |
|---|---|---|
| reports | ||
| GET |
Message reports /reports/{id} |
|
| GET |
Clicks of a message /reports/{id}/clicks |
|
| GET |
Unsubscribes of a message /reports/{id}/unsubscribes |
|
| GET |
Views of a message /reports/{id}/views |
|
| GET |
Aggregated unsubscribes /reports/{id}/aggregated_unsubscribes |
Returns aggregate by specific unsubscribe reason |
| GET |
Invalid contacts /reports/{id}/invalids |
Lists invalid contacts from message |
| transactional_deliveries | ||
| POST |
Send transactional delivery /transactional_deliveries/send |
This method should be used to send transactional messages (messages to only a one address) |
| GET |
Transactional Deliveries Bounce /transactional_deliveries/bounces/{id} |
|
| GET |
Transactional Deliveries Bounces /transactional_deliveries/bounces |
|
| lists | ||
| PUT |
Quick import contacts /lists/{id}/import |
Imports up to 100 contacts |
| DELETE |
Delete a list /lists/{id} |
|
| POST |
Create a list /lists |
You will have to select a list of contacts to send a message. Using this method you will be able to create a new list. |
| GET |
All lists /lists |
|
| GET |
Total active contacts of a list /lists/{id}/total_active_contacts |
|
| PUT |
Update list information /lists/{id} |
|
| GET |
List's contacts /lists/{id}/contacts |
list's contacts |
| GET |
View list /lists/{id} |
|
| templates | ||
| DELETE |
Delete template /templates/{id} |
|
| POST |
Create new template /templates |
|
| GET |
Get template html /templates/{id}/html |
|
| GET |
List all templates /templates |
|
| GET |
Template information /templates/{id} |
|
| PUT |
Update template information /templates/{id} |
|
| PUT |
Generate template thumbnail /templates/{id}/update_thumb |
Generate thumbmail |
| messages | ||
| GET |
Message sending status /messages/{id}/sending_status |
|
| POST |
Create message /messages |
You should use this method to start the creation of a message |
| GET |
List all messages /messages |
|
| GET |
Message information /messages/{id} |
|
| PUT |
Send or schedule message /messages/{id}/ready |
send or schedule the message to be sent |
| PUT |
Send test for message /messages/{id}/test |
send test messages |
| GET |
Update message html /messages/{id}/html |
|
| GET |
messages new /messages/new |
|
| PUT |
Build message /messages/{id}/build |
Build message, count contacts and send it(optinal) |
| client | ||
| GET |
Me /me |
info about your account |
| GET |
Valid key /valid_key |
check if your api_key is valid |
| contacts | ||
| PUT |
Remove a contact from a list /contacts/{id}/list_unsubscribe |
|
| POST |
Create a contact /contacts |
Create a new contact |
| PUT |
Add a contact to a list /contacts/{id}/list_subscribe |
To send messages you will need to select lists of contacts. This method should be used to add a contact to a list. |
| GET |
All contacts /contacts |
List all contacts of your account |
| PUT |
Update contact information /contacts/{id} |
|
| PUT |
Unsubscribe contact /contacts/{id}/unsubscribe |
Unsubscribe a contact from your account. Warning: the contact won't receive your none of your message anymore. |
| GET |
View contact /contacts/{id} |
|
| GET |
contacts new /contacts/new |
|
Mailee Client v2 pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|