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

GET Layout list

\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\r\n\r\n
KeyTypeDescription
Statusstring1 if successful, -1 if error
CountintTotal number
DataLayoutListDataLayout Data
" }, { "info": { "name": "GET Template Category list", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/TemplateCategory" }, "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\r\n\r\n
KeyRequiredTypeDescription
LanguageoptionalintLanguage
Filter[Version]optionalintVersion
IsRSSoptionalint1 if RSS, 0 otherwise
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n" }, { "info": { "name": "GET Template Category By Category ID", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/TemplateCategory/:CategoryID", "params": [ { "name": "CategoryID", "value": "", "type": "path" } ] }, "docs": "

GET Template Category By Category ID

\r\n

URL Parameters

\r\n
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{CategoryID}}requiredstringID of the template category
\r\n\r\n

Query String parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
Languageoptionalstri" }, { "info": { "name": "GET Template By Template ID ", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/Template/:TemplateID", "params": [ { "name": "TemplateID", "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
{{TemplateID}}requiredstringIDs of the template
\r\n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\nGET Badges List\r\n\r\n

Response body 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
KeyTypeDescription
BadgeBadgeBadge Data
" }, { "info": { "name": "Get Scheme", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Emails/Scheme" }, "docs": "

Get Scheme

\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\r\n\r\n
KeyRequiredTypeDescription
FilteroptionalstringFilter, default or saved
LanguageoptionalstringLanguage
FilterTypeoptionalstringFilter Type, type
\r\n\r\n

Response b" }, { "info": { "name": "Add / Update Scheme", "type": "http" }, "http": { "method": "PATCH", "url": "https://clientapi.benchmarkemail.com/Emails/Scheme" }, "docs": "

Add / Update Scheme

\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\r\n
KeyRequiredTypeDescription
Overwriteoptionalint1 Overwrite existing scheme\r\n0 Don't overwrite existing scheme
LanguageoptionalstringLanguage
\r\n\r\n

Body Parameters (To be passed as a JSON string)

\r\n\r\n<" }, { "info": { "name": "Delete Scheme", "type": "http" }, "http": { "method": "DELETE", "url": "https://clientapi.benchmarkemail.com/Emails/Scheme/: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 Scheme
\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 Templates\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

Query String parameters

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
PageNumberoptionalintPage number
Pa" }, { "info": { "name": "Get Editor Integration Connection List", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Client/Integrations" }, "docs": "

Get Integration List

\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 Ebay Site List ", "type": "http" }, "http": { "method": "GET", "url": "https://clientapi.benchmarkemail.com/Client/Integrations/EbaySite" }, "docs": "

Get Ebay Site List

\nResponse Body Parameters :\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterTypeDescription
DataGenericListGeneric List
" } ] } ], "bundled": true }