{ "opencollection": "1.0.0", "info": { "name": "Benchmark Email RESTful API v3.0 ABTest Creation List Configurations & Searches API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "AuthToken", "value": "{{AuthToken}}", "placement": "header" } }, "items": [ { "info": { "name": "List Configurations & Searches", "type": "folder" }, "items": [ { "info": { "name": "/ | All lists or filter for a list, Get a list of contacts", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Contact/", "params": [ { "name": "Status", "value": "", "type": "query" }, { "name": "PageNumber", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "SearchFilter", "value": "", "type": "query" }, { "name": "OrderBy", "value": "", "type": "query" }, { "name": "SortOrder", "value": "", "type": "query" } ] }, "docs": "

Get a list of contacts

\r\n\r\n

Query String parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
PageNumberoptionalintPage number
PageSizeoptionalintNumber of records to show per page
OrderByoptionalstringField to order by, email, date, count, " }, { "info": { "name": "/ | Create new List, Create List", "type": "http" }, "http": { "method": "POST", "url": "https://clientapi.benchmarkemail.com/Contact/", "body": { "type": "json", "data": "{}" } }, "docs": "

Create 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\r\n\r\n
KeyRequiredTypeDescription
DatarequiredContactMasterRecordList Details
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n" }, { "info": { "name": "/{{ListID}} | Deep View, Get contact lists detail", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Contact/:ListID", "params": [ { "name": "ListID", "value": "", "type": "path" } ] }, "docs": "

Get contact lists detail

\r\n

URL Parameters

\r\n
KeyTypeDescription
\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
Da" }, { "info": { "name": "/{{ListID}} || Delete list", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Contact/:ListID", "params": [ { "name": "ListID", "value": "", "type": "path" } ] }, "docs": "

Delete Single 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\n<" }, { "info": { "name": "/{{ListID}}/Fields | Field Names, Get contact lists attributes", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Contact/:ListID/Fields", "params": [ { "name": "ListID", "value": "", "type": "path" } ] }, "docs": "

Get contact lists attributes

\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
{{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\nGet contact lists\r\n

URL 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
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" }, { "info": { "name": "Delete List Check", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Contact/DeleteListCheck/:ListIDs", "params": [ { "name": "ListIDs", "value": "", "type": "path" } ] }, "docs": "

Get a list of contacts

\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
{{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" } ] } ], "bundled": true }