{ "opencollection": "1.0.0", "info": { "name": "Benchmark Email RESTful API v3.0 ABTest Creation Email Email Rss Creation API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "AuthToken", "value": "{{AuthToken}}", "placement": "header" } }, "items": [ { "info": { "name": "Email Email Rss Creation", "type": "folder" }, "items": [ { "info": { "name": "Get Details of Email", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get Details of Email

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringIDs of the EMail
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n<" }, { "info": { "name": "Update the email", "type": "http" }, "http": { "method": "PATCH", "url": "https://clientapi.benchmarkemail.com/Emails/:ID", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Update the email

\r\n

URL Parameters

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
Error
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Body Parameters (To be passed as a JSON string)

\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
DetailrequiredGet a list of contacts\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n<" }, { "info": { "name": "Create Email", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Emails/", "body": { "type": "json", "data": "{}" } }, "docs": "

Create Email

\r\n\r\n

Body Parameters (To be passed as a JSON string)

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
Data
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
DetailrequiredEmailDataEmail Details
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n<" }, { "info": { "name": "Get the recipient count for the email", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/RecipientCount", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n

URL Parameters

\r\n
KeyTypeDescription
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the Email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
Statusstring1 = Successful, -1 Error
Count" }, { "info": { "name": "/{{ID}}/Schedule | Send Email", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Schedule", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Schedule the email

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Body Parameters (To be passed as a JSON string)

\r\n\r\n\r\n\r\n\r\n\r\n\r\nGet a list of contacts\r\n

URL Parameters

\r\n
KeyRequiredTypeDescription
ScheduleDaterequiredstring
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Body Parameters (To be passed as a JSON string)

\r\n\r\n\r\n\r\n\r\n\r\n\r\nGet a list of contacts\r\n

URL Parameters

\r\n
KeyRequiredTypeDescription
Schedulerequiredstring
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Body Parameters (To be passed as a JSON string)

\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
EmailsrequiredstringC" }, { "info": { "name": "SpamCheck", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Spam", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

SpamCheck

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringID of the email
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
ErrorGet a list of contacts\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
DataGenericListCommunity Category Data
" } ] } ], "bundled": true }