ESP API Methods
Table of Contents:
Methods Summary
GET api/esp_connections/options
Description
Retrieve all the ESP vendor connections in your account. Those residing under the Vendor-Settings → My Connections in the UI of your account.
Request
active_only
Optional boolean (e.g., ?active_only=true). Default: false
Response
GET URL: https://api.ongage.net/<list_id>/api/esp_connections/options
{
"metadata": {
"error": false
},
"payload": [
{
"id": "14897",
"esp_id": "4",
"esp_name": "Amazon SES",
"support_transactional": "1",
"name": "Amazon SES"
},
{
"id": "14895",
"esp_id": "10",
"esp_name": "Dyn",
"support_transactional": "1",
"name": "Dyn"
},
{
"id": "15074",
"esp_id": "58",
"esp_name": "Mailgun",
"support_transactional": "1",
"name": "Mailgun"
},
{
"id": "14889",
"esp_id": "59",
"esp_name": "Private SMTP",
"support_transactional": "1",
"name": "Private SMTP"
},
{
"id": "14864",
"esp_id": "19",
"esp_name": "SendGrid",
"support_transactional": "1",
"name": "SendGrid"
},
{
"id": "14896",
"esp_id": "86",
"esp_name": "SparkPost",
"support_transactional": "1",
"name": "SparkPost"
}
]
}POST /api/esp_connections
Description
Create ESP vendor connections in your account. It only creates connection and in order to activate the connection, need to add Credentials/Email Attributes manually in UI.
Response
POST URL: https://api.ongage.net/api/esp_connection
{
"esp_id": <esp_id>
}You can find the esp_id for each vendor in the List given below.
Response
{
"metadata": {
"error": false
},
"payload": {
"esp_id": "",
"account_id": "",
"creator_id": "",
"id": "",
"currency": "",
"created": "",
"modified": "",
"unsubscribe_keywords": null,
"help_message_id": null,
"help_transactional_id": null
}
}List Of ESP ID for each Vendors
esp_id | Vendor Name |
4 | Amazon SES |
9 | |
131 | Bird |
19 | SendGrid |
43 | SocketLabs |
86 | SparkPost |
93 | SparkPost Enterprise |
51 | mySMTP |
58 | Mailgun |
59 | Private SMTP |
61 | Mandrill |
81 | MailJet V3 |
92 | InboxRoad |
97 | OpenText |
101 | CM. |
102 | Twilio |
110 | SparkPost Momentum |
112 | MessageMedia Rest |
120 | Pepipost |
126 | Oracle Cloud Infrastructure |
128 | OpenText Rest |
21 | Elastic Email |
27 | Blue Hornet |
18 | MailChimp |
15 | Teradata |