Introduction
Welcome to the Dyno Email Marketing API! You can use our API to access information on various objects in our system.
We have language bindings in Curl, Java, Python, Php ! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
Enviroment
Production: api.mail.dyno.me:19000
Authentication
To authorize, use this header in your request:
User-Api-Key:dyno
Make sure to replace dyno with your API key.
You can register a new API key at our setting module
API convention
Request
Request must set header User-Api-Key
PUT & POST request must set header Content-Type to application/json
Find & Count request must based on flat json to support dynamic filtering, listing Our api support following type with operations
String
Equal
Like
Like: like Like ignore case: like_ignore_case Like regex: like_regex
Not Like
Not Like: not_like Not Like ignore case: not_like_ignore_case Not Like regex: not_like_regex
In: in
Not in: not_in
Sample:
Equal: {“username”:“username”} Like: “email”:{“like”:“thanhdd”} In: “id”: {“in”: “123,234”}
Number
Equal: eq
Greater than: gt
Greater than or equal: gte
Less than: lt
Less than or equal: lte
Sample: {“created”:{“gte”:1439054168}}
Select specific fields
application_fields: Type: Json array Sample: “application_fields” : [“id”, “username”]
Paging
application_limit application_offset
Order
application_order_by:
Response
HTTP Code 200
{
"has_error": false,
"error_code": "",
"data": {
"user_id":"4d1b9220-5a43-11e6-ae4a-6e8264809144"
}
}
HTTP Code 500
{
"has_error": true,
"error_code": "123”
"error message": "RESOURCE NOT FOUND"
}
Templates
Get
HTTP Request
GET http://api.mail.dyno.me:19000/templates/:id
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Create
HTTP Request
POST http://api.mail.dyno.me:19000/templates
The above command returns JSON structured like this:
json
Change info
HTTP Request
PUT http://api.mail.dyno.me:19000/templates/:id
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Delete
HTTP Request
DELETE http://api.mail.dyno.me:19000/templates/:id
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Find
HTTP Request
POST http://api.mail.dyno.me:19000/templates/find
The above command returns JSON structured like this:
json
Count
HTTP Request
POST http://api.mail.dyno.me:19000/templates/count
The above command returns JSON structured like this:
json
Lists
Get
HTTP Request
GET http://api.mail.dyno.me:19000/lists/:id
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Create
HTTP Request
POST http://api.mail.dyno.me:19000/lists
The above command returns JSON structured like this:
json
Change info
HTTP Request
PUT http://api.mail.dyno.me:19000/lists/:id
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Delete
HTTP Request
DELETE http://api.mail.dyno.me:19000/lists/:id
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Find
HTTP Request
POST http://api.mail.dyno.me:19000/lists/find
The above command returns JSON structured like this:
json
Count
HTTP Request
POST http://api.mail.dyno.me:19000/lists/count
The above command returns JSON structured like this:
json
Campaigns
Get
HTTP Request
GET http://api.mail.dyno.me:19000/campaigns/:id
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Create
HTTP Request
POST http://api.mail.dyno.me:19000/campaigns
The above command returns JSON structured like this:
json
Change info
HTTP Request
PUT http://api.mail.dyno.me:19000/campaigns/:id
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Delete
HTTP Request
DELETE http://api.mail.dyno.me:19000/campaigns/:id
Query Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Find
HTTP Request
POST http://api.mail.dyno.me:19000/campaigns/find
The above command returns JSON structured like this:
json
Count
HTTP Request
POST http://api.mail.dyno.me:19000/campaigns/count
The above command returns JSON structured like this:
json
Campaigns process
Start campaign
HTTP Request
POST http://api.mail.dyno.me:19000/campaign_process/init
Parameters
| Parameter | Default | Description |
|---|---|---|
| campaign_id | campaign id | |
| iso_start_time | (yyyy-MM-dd’T'HH:mm:ss): optional | |
| time_zone | optional | |
| subject | optional | |
| from_name | optional | |
| from_email | optional | |
| preview_message | optional |
The above command returns JSON structured like this:
json
Update & resume campaign
HTTP Request
POST http://api.mail.dyno.me:19000/campaign_process/update_and_resume
Parameters
| Parameter | Default | Description |
|---|---|---|
| campaign_id | campaign id | |
| subject | optional | |
| from_name | optional | |
| from_email | optional | |
| preview_message | optional |
The above command returns JSON structured like this:
json
Reschedule campaign
HTTP Request
POST http://api.mail.dyno.me:19000/campaign_process/reschedule
Parameters
| Parameter | Default | Description |
|---|---|---|
| campaign_id | campaign id | |
| iso_start_time | (yyyy-MM-dd’T'HH:mm:ss): optional | |
| time_zone | optional | |
| subject | optional | |
| from_name | optional | |
| from_email | optional | |
| preview_message | optional |
The above command returns JSON structured like this:
json
Cancel schedule
HTTP Request
POST http://api.mail.dyno.me:19000/campaign_process/cancel_schedule
Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Stop campaign
HTTP Request
POST http://api.mail.dyno.me:19000/campaign_process/stop
Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Pause campaign
HTTP Request
POST http://api.mail.dyno.me:19000/campaign_process/pause
Parameters
| Parameter | Default | Description |
|---|---|---|
| id | Object id |
The above command returns JSON structured like this:
json
Resume campaign
HTTP Request
POST http://api.mail.dyno.me:19000/campaign_process/resume
The above command returns JSON structured like this:
json
Transactions
Send
HTTP Request
POST http://api.mail.dyno.me:19000/transactions
Parameters
| Parameter | Default | Description |
|---|---|---|
| email_content | campaign id | |
| subject | (yyyy-MM-dd’T'HH:mm:ss): optional | |
| from_name | optional | |
| subject | optional | |
| from_email | optional | |
| email_list | optional | |
| preview_message | optional |
The above command returns JSON structured like this:
json
Errors
The Dyno Email Marketing API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request – Your request |
| 401 | Unauthorized – Your API key is wrong |
| 403 | Forbidden – The requested is hidden for administrators only |
| 404 | Not Found – The specified api could not be found |
| 429 | Too Many Requests – You’re requesting too many |
| 500 | Internal Server Error – We had a problem with our server. |
| 503 | Service Unavailable – We’re temporarially offline for maintanance. |