{ "opencollection": "1.0.0", "info": { "name": "Benchmark Email RESTful API v3.0 ABTest Creation General API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "AuthToken", "value": "{{AuthToken}}", "placement": "header" } }, "items": [ { "info": { "name": "General", "type": "folder" }, "items": [ { "info": { "name": "Get Notification", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Client/Notification" }, "docs": "

Get Notification

\nResponse body parameters :\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterTypeDescription
DataNotificationDataArray
ErrorsErrorDataArrayCheck if Responsive \nResponse body parameters :\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterTypeDescription
IsResponsiveString0=Not,1 =Responsive
ErrorsErrorDataArray
Statusstring<" }, { "info": { "name": "Set Responsive", "type": "http" }, "http": { "method": "PATCH", "url": "https://clientapi.benchmarkemail.com/Client/Responsive", "body": { "type": "json", "data": "{}" } }, "docs": "

Set Responsive

\nBody Parameters (to be encoded as a JSON string)\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyRequiredDescription
IsResponsiveRequiredIs Responsive=1,Not = 0
\nResponse body parameters :\n\n \n \n \n \n \n \n \n \n \n \n
ParameterTypeDescription
IsResponsiveStringGet Clients Rating Range\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterTypeDescription
MinRatingStringMin Rating
MaxRatingstringMax Rating
" }, { "info": { "name": "Get Archive Domain Name", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Client/Archive/Domain" }, "docs": "

Get Archive Domain Name

\nQuery String Parameters : None
\n\nRequest Body Parameters: None
\n\nResponse Body Parameters :\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterTypeDescription
DomainNamestringDomain Name
" }, { "info": { "name": "Get Community Domain", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Client/Community/Domain" }, "docs": "

Get Community Domain

\nQuery String Parameters : None
\n\nRequest Body Parameters: None
\n\nResponse Body Parameters :\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterTypeDescription
DomainNamestringDomain Name
" }, { "info": { "name": "Get DMARC List", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Client/DMarc" }, "docs": "

Get DMarc List

\nQuery String Parameters : None
\n\nRequest Body Parameters: None
\n\nResponse Body Parameters :\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterTypeDescription
DataGenericListGeneric List
" }, { "info": { "name": "Get List Upload Terms", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Client/ListUploadTerms" }, "docs": "

Get List Upload Terms

\nResponse Body Parameters :\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterTypeDescription
StatusString1=successfull,-1 not success
ErrorErrorDataArray of error
Data<" }, { "info": { "name": "Modify Contact List", "type": "http" }, "http": { "method": "PATCH", "url": "https://clientapi.benchmarkemail.com/Contact/:ListID", "params": [ { "name": "ListID", "value": "", "type": "path" } ] }, "docs": "Modifies an existing contact list\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredDescription
{{ListID}}requiredID of the contact list

\r\n

Body Parameters (To be passed as a JSON string)

\r\n\r\n \r\n \r\n \r\n \r\n Delete the selected contacts from current lists \r\n

Request body parameters

\r\n
KeyRequiredDescription
NameoptionalList Name
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
SearchoptionalstringSearch value like email address
FilteroptionalstringFilter value
\r\n\r\n

Body Parameters (To be passed as a JSON string)

\r\n\r\n\r\n\r\n<" }, { "info": { "name": "Download report", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Contact/:ID/Download", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Download report

\r\n

URL Parameters

\r\n
Key
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}requiredstringIDs of the list
\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
PINrequiredstring4 digit Sec" }, { "info": { "name": "Compare contacts", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Contact/:ListIDs/Compare", "params": [ { "name": "ListIDs", "value": "", "type": "path" } ] }, "docs": "Compares contacts\n

Response: 1 if successful, -1 if error

\n

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyRequiredDescription
{{ListIDs}}requiredIDs of the lists
\n\n

Response body parameters

\n\n\n\n\n\n\n\n\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
" }, { "info": { "name": "Clean List", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Contact/:CleanListID/Clean", "params": [ { "name": "CleanListID", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cleans the specified list\n

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyRequiredDescription
{{CleanListID}}requiredID of the contact list to be cleaned
\n\n

Body Parameters (to be encoded as a JSON string)

\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyRequiredDescription
HardBouncesrequired1 if hard bounces are to be clean" }, { "info": { "name": "Delete Trash List", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Contact/:ListID/Trash", "params": [ { "name": "ListID", "value": "", "type": "path" } ] }, "docs": "

Delete Trash List

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListID}}requiredstringID of the list
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nDelete the selected contacts from current list from contact details page\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
{{ListID}}optionalstringID of the list
{{ContactID}}optionalstringID of the contact
\r\n\r\n

Request body parameters

\r\n\r\n\r\n\r\n
KeyRequired" }, { "info": { "name": "Delete the selected contacts from ALL lists from Contact Details page ", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Contact/:ListID/ContactDetails/All/:ContactID", "params": [ { "name": "ListID", "value": "", "type": "path" }, { "name": "ContactID", "value": "", "type": "path" } ] }, "docs": "

Delete the selected contacts from ALL lists from Contact Details page

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListID}}requiredstringID of the list
{{ContactID}}requiredstringID of the contact
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n<" }, { "info": { "name": "DELETE Contact only from search contact page", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Contact/ContactDetails/:ContactID", "params": [ { "name": "ContactID", "value": "", "type": "path" } ] }, "docs": "

Delete Contact only from search contact page

\r\n

URL Parameters

\r\n
KeyType
\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ContactID}}requiredstringID of the contact
\r\n\r\n

Request body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
SearchoptionalstringMove Contacts to Do Not Contact (i.e Master Unsubscribe list)\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListID}}requiredstringID of the list
{{ContactIDs}}requiredstringID of the Contact
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n
KeyTypeDesc" }, { "info": { "name": "Move Contacts", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Contact/:ListID/MoveContacts/:TargetListID/:ContactIDs", "params": [ { "name": "ListID", "value": "", "type": "path" }, { "name": "TargetListID", "value": "", "type": "path" }, { "name": "ContactIDs", "value": "", "type": "path" } ] }, "docs": "

Move Contacts

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListID}}requiredstringID of the list
{{TargetListIDs}}requiredstringID of the target list where the contact is to be moved
{{ContactIDs}}requiredstringID of the Contact
\r\n\r\n

Resp" }, { "info": { "name": "Move Bulk Contacts", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Contact/:ListID/MoveContacts", "params": [ { "name": "ListID", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Move Bulk Contacts

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListID}}requiredstringID of the list
\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
TargetListIDsrequiredstringCopy Contacts\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListID}}requiredstringID of the list
{{ContactID}}requiredstringID of the contact
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
Sta" }, { "info": { "name": "Copy Bulk Contacts", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Contact/CopyContacts" }, "docs": "

Copy Bulk Contacts

\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\r\n\r\n\r\n
KeyRequiredTypeDescription
TargetListIDsrequiredstringTarget List ID
ContactIDsrequiredstringComma separated list of Contact IDs
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n
KeyTypeShare Lists with SubAccounts\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListID}}requiredstringID of the list
{{ClientIDs}}requiredstringClient ID of the sub-accounts with whom to share
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n
KeyTypeDescrip" }, { "info": { "name": "Resend Email", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Contact/:ListID/ResendEmails", "params": [ { "name": "ListID", "value": "", "type": "path" } ] }, "docs": "

Resend Email

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListID}}requiredstringID of the list
\r\n\r\n

Post Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nGet contact Merge List\r\n

URL Parameters

\r\n
KeyRequiredTypeDescription
{{ContactID}}requiredstringIDs of the contact
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListIDs}}requiredstringIDs of the lists
\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
Data" }, { "info": { "name": "Merge contacts into Existing List", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Contact/:ListIDs/MergeIntoExistingList", "params": [ { "name": "ListIDs", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Merge contacts into Existing List

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListIDs}}requiredstringIDs of the lists
\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
TargetListIDoptionalMerge contacts into new list\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListIDs}}requiredstringIDs of the lists
\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
NewListrequiredstr" }, { "info": { "name": "Split contacts into new list", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Contact/:ListID/SplitIntoListNewList", "params": [ { "name": "ListID", "value": "", "type": "path" } ] }, "docs": "

Split contacts into new list

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListIDs}}requiredstringIDs of the lists
\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
NewListrequiredstr" }, { "info": { "name": "Delete List", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Contact/DeleteList/:ListIDss", "params": [ { "name": "ListIDss", "value": "", "type": "path" } ] }, "docs": "

Delete List

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListIDs}}requiredstringIDs of the lists
\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
Error<" }, { "info": { "name": "Delete Trash List", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Contact/DeleteTrashList/:ListIDs", "params": [ { "name": "ListIDs", "value": "", "type": "path" } ] }, "docs": "

Get 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
{{ListIDs}}requiredstringIDs of the lists
\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
Erro" }, { "info": { "name": "Restore Trash List", "type": "http" }, "http": { "method": "PATCH", "url": "https://clientapi.benchmarkemail.com/Contact/RestoreTrashList/:ListIDs", "params": [ { "name": "ListIDs", "value": "", "type": "path" } ] }, "docs": "

Restore Trash List

\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ListIDs}}requiredstringIDs of the lists
\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
ErrorCopy an existing 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\n
KeyRequiredTypeDescription
NamerequiredstringNam" }, { "info": { "name": "Delete the email", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Emails/:ID", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Delete 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}}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
KeyTypeDescription
Statusstring1 if successful, -1 if error
DataGet 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}}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": "Permenantly delete an email from Trash", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Trash", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Permenantly delete an email from Trash

\r\n

URL Parameters

\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
{{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": "Get the Preview for the email", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/Preview", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\r\n\r\n

Query String parameters

\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
EmailAddressoptionalstringEmail Address
HTMLContentoptionalstringHTML Content
TextContentoptionalstringText Content
\r\n\r\n

Response body parameters

\r\n\r" }, { "info": { "name": "Add Email to Community", "type": "http" }, "http": { "method": "PATCH", "url": "https://clientapi.benchmarkemail.com/Emails/Community/:ID", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Get 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

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
Communityrequiredstring
\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
IDstringID
CommunityNamestringCom" }, { "info": { "name": "Share Template to sub accounts", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/ShareTemplate", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Share Template to sub accounts

\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\n
KeyRequiredTypeDescription
SubAccountrequiredstri" }, { "info": { "name": "Delete ABSplit Campaign", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Emails/:ID/ABSplit", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Delete ABSplit Campaign

\r\n\r\n

URL parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
IDoptionalstringID 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": "Get list of automation ", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Automation", "params": [ { "name": "PageNumber", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "Filter", "value": "", "type": "query" }, { "name": "OrderBy", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" } ] }, "docs": "Get a list of automation\n

Query String Parameter :

\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
Error
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyRequiredDescription
PageNumberoptionalPage Number
PageSizeoptionalNumber of records to show per page
FilteroptionalFilter for automation name
OrderByoptionalColumn by which to sort like name,schedule,email,status,da" }, { "info": { "name": "Delete an Automation", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Automation/:AutomationID", "params": [ { "name": "AutomationID", "value": "", "type": "path" } ] }, "docs": "Delete an automation\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredDescription
{{AutomationID}}RequiredAutomation ID
\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
StatusString1 if success, -1 if error
ErrorURL Parameters\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredDescription
{{AutomationID}}RequiredAutomation ID\r\n
{{AutomationDetailID}}RequiredAutomation email ID\r\n
\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
" }, { "info": { "name": "Delete an Automation Email", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Automation/:AutomationID/Emails/:AutomationDetailID", "params": [ { "name": "AutomationID", "value": "", "type": "path" }, { "name": "AutomationDetailID", "value": "", "type": "path" } ] }, "docs": "Delete an Automation Email \r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredDescription
{{AutomationID}}RequiredAutomation ID\r\n
{{AutomationDetailID}}RequiredAutomation Email ID\r\n
\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyTypeDescription
Status<" }, { "info": { "name": "Create copy of exiting Automation", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Automation/:AutomationID/Copy", "params": [ { "name": "AutomationID", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create copy of an Automation\r\n

URL Parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredDescription
{{AutomationID}}RequiredAutomation ID\r\n
\r\n

Body Parameters (to be encoded as a JSON string)

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredDescription
{{Name}}RequiredName of the new automation" }, { "info": { "name": "Get a list of AB Tests", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/ABSplit/", "params": [ { "name": "PageNumber", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "Filter", "value": "", "type": "query" }, { "name": "FilterType", "value": "", "type": "query" }, { "name": "OrderBy", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" } ] }, "docs": "Get a Inbox List\r\n

URL body parameter

\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n " }, { "info": { "name": "Delete the AB Test email", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/ABSplit/:ID", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "Move the email to trash\r\n

URL parameters:

\r\n
ParameterTypeDescription
PageNumberstringPage Number
PageSizestringNumber of rows on the page
OrderBystringOrder By Column
Filter
\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
ParameterTypeDescription
IDstringABSplit ID
\r\n

Response body parameters:

\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
ParameterTypeDescription
Statusstring1 if successful, -1 if error" }, { "info": { "name": "Update the AB Test Status", "type": "http" }, "http": { "method": "PATCH", "url": "https://clientapi.benchmarkemail.com/ABSplit/:ID/Status", "params": [ { "name": "ID", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the ABSplit Status\r\n

URL parameters:

\r\n\r\n\r\n \r\n \r\n \r\n\r\n\r\n \r\n \r\n \r\n\r\n
ParameterTypeDescription
IDstringABSplit ID
\r\n

Body Parameters (to be encoded as a JSON string)

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredDescription
StatusRequiredStatus of AB test like draft/START/SCHEDULE/AUTOMATIC/SUSPEND/RESCHEDULE" }, { "info": { "name": "Get a list of survey", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Survey", "params": [ { "name": "PageNumber", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "OrderBy", "value": "", "type": "query" }, { "name": "Filter", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" } ] }, "docs": "

Get a list of survey

\nQuery string parameters:\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
PageNumberOptionalintPage Number
PageSizeOptionalintNumber of rows on the page
OrderByOptionalst" }, { "info": { "name": "Copy a Survey", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Survey/:ID/Copy", "params": [ { "name": "ID", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Copy a Survey

\nQuery String Parameters : None
\nRequest Body Parameters : \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
IDRequiredstringSurvey ID
NameRequiredstringSurvey Name
\nRe" }, { "info": { "name": "Delete a Survey", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Survey/:ID", "params": [ { "name": "ID", "value": "", "type": "path" } ] }, "docs": "

Delete a Survey

\nQuery string Parameters : None
\nRequest Body Parameters : \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
IDRequiredstringSurvey ID
\n\nResponse Body Parameters : \n\n \n \n \n \n <" }, { "info": { "name": "Update status of the survey", "type": "http" }, "http": { "method": "PATCH", "url": "https://clientapi.benchmarkemail.com/Survey/:ID/StatusUpdate/:Status", "params": [ { "name": "ID", "value": "", "type": "path" }, { "name": "Status", "value": "", "type": "path" } ] }, "docs": "

Update status of the survey

\nQuery string parameters : None
\nRequest Body Parameters:\n
ParameterType
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
IDRequiredstringSurvey ID
StatusRequiredstring1 Active, 0 Inactive, 3 ReactivateGet list of Polls.\nQuery string parameters : \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
FilterOptionalintFilterr
PageNumberRequiredintPage Number
PageSizeRequiredintNumbe" }, { "info": { "name": "Copy a poll", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Poll/:PollID/Copy", "params": [ { "name": "PollID", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

Copy a poll

\nQuery string parameters : \n\n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
PollIDRequiredstringPoll ID
\nRequest Body Parameters : \n\n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
NameRequiredstringName of" }, { "info": { "name": "Delete a poll", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Poll/:PollID", "params": [ { "name": "PollID", "value": "", "type": "path" } ] }, "docs": "

Delete a poll

\nQuery string parameters : None
\nRequest Body Parameters : \n\n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
PollIDRequiredstringPoll ID
\nResponse Body Parameters : \n\n \n \n \n \n \n \n \n \n
ParameterTypeDescription
ResponseintID " }, { "info": { "name": "Get preview of a poll", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Poll/:PollID/Render", "params": [ { "name": "PollID", "value": "", "type": "path" } ] }, "docs": "

Get preview of a poll

\nQuery string parameters : None
\nRequest Body parameters:\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterRequiredTypeDescription
PollIDRequiredStringPoll ID
\n\nResponse body parameters :\n\n \n \n \n \n " } ] } ], "bundled": true }
ParameterType