\n | Errors | \n ErrorData | \n Array"
},
{
"info": {
"name": "Check if Responsive",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://clientapi.benchmarkemail.com/Client/Responsive"
},
"docs": "Check if Responsive \nResponse body parameters :\n\n \n \n | Parameter | \n Type | \n Description | \n \n \n \n \n | IsResponsive | \n String | \n 0=Not,1 =Responsive | \n \n \n | Errors | \n ErrorData | \n Array | \n \n \n | Status | \n string<"
},
{
"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| Key | \nRequired | \nDescription | \n \n\n\n\n| IsResponsive | \nRequired | \nIs Responsive=1,Not = 0 | \n \n\n \nResponse body parameters :\n\n \n \n | Parameter | \n Type | \n Description | \n \n \n \n \n | IsResponsive | \n String | Get Clients Rating Range\n\n \n \n | Parameter | \n Type | \n Description | \n \n \n \n \n | MinRating | \n String | \n Min Rating | \n \n \n | MaxRating | \n string | \n Max Rating | \n \n \n "
},
{
"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 | Parameter | \n Type | \n Description | \n \n \n \n \n | DomainName | \n string | \n Domain Name | \n \n \n "
},
{
"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 | Parameter | \n Type | \n Description | \n \n \n \n \n | DomainName | \n string | \n Domain Name | \n \n \n "
},
{
"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 | Parameter | \n Type | \n Description | \n \n \n \n \n | Data | \n GenericList | \n Generic List | \n \n \n "
},
{
"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 | Parameter | \n Type | \n Description | \n \n \n \n \n | Status | \n String | \n 1=successfull,-1 not success | \n \n \n | Error | \n ErrorData | \n Array of error | \n \n \n | Data | \n <"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | \r\nRequired | \r\nDescription | \r\n \r\n\r\n\r\n\r\n| {{ListID}} | \r\nrequired | \r\nID of the contact list | \r\n \r\n\r\n \r\nBody Parameters (To be passed as a JSON string)\r\n\r\n \r\n | Key | Required | Description | \r\n \r\n \r\n | Name | optional | List Name | "
},
{
"info": {
"name": "Delete the selected contacts from current lists",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://clientapi.benchmarkemail.com/Contact/ContactDetails",
"params": [
{
"name": "Search",
"value": "",
"type": "query"
},
{
"name": "Filter",
"value": "",
"type": "query"
}
]
},
"docs": "Delete the selected contacts from current lists \r\nRequest body parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| Search | optional | string | Search value like email address | \r\n| Filter | optional | string | Filter value | \r\n\r\n \r\n\r\nBody Parameters (To be passed as a JSON string)\r\n\r\n\r\n\r\n| Key | <"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ID}} | required | string | IDs of the list | \r\n\r\n \r\n\r\nBody Parameters (To be passed as a JSON string)\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| PIN | required | string | 4 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\nResponse: 1 if successful, -1 if error\nURL Parameters\n\n\n\n| Key | \nRequired | \nDescription | \n \n\n\n\n| {{ListIDs}} | \nrequired | \nIDs of the lists | \n \n\n \n\nResponse body parameters\n\n\n\n| Key | Type | Description | \n\n\n| Status | string | 1 if successful, -1 if error | \n\n "
},
{
"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\nURL Parameters\n\n\n\n| Key | \nRequired | \nDescription | \n \n\n\n\n| {{CleanListID}} | \nrequired | \nID of the contact list to be cleaned | \n \n\n \n\nBody Parameters (to be encoded as a JSON string)\n\n\n\n| Key | \nRequired | \nDescription | \n \n\n\n\n| HardBounces | \nrequired | \n1 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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListID}} | required | string | ID of the list | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n| Status | string | 1 if successful, -1 if error | \r\n| Error | Delete the selected contacts from current list from contact details page\r\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n{{ListID}} | optional | string | ID of the list | \r\n| {{ContactID}} | optional | string | ID of the contact | \r\n\r\n \r\n\r\nRequest body parameters\r\n\r\n\r\n\r\n| Key | Required"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n{{ListID}} | required | string | ID of the list | \r\n| {{ContactID}} | required | string | ID of the contact | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | <"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n{{ContactID}} | required | string | ID of the contact | \r\n\r\n \r\n\r\nRequest body parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| Search | optional | stringMove Contacts to Do Not Contact (i.e Master Unsubscribe list)\r\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListID}} | required | string | ID of the list | \r\n| {{ContactIDs}} | required | string | ID of the Contact | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Desc"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListID}} | required | string | ID of the list | \r\n| {{TargetListIDs}} | required | string | ID of the target list where the contact is to be moved | \r\n| {{ContactIDs}} | required | string | ID of the Contact | \r\n\r\n \r\n\r\nResp"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListID}} | required | string | ID of the list | \r\n\r\n \r\n\r\nBody Parameters (To be passed as a JSON string)\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| TargetListIDs | required | string | Copy Contacts\r\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListID}} | required | string | ID of the list | \r\n| {{ContactID}} | required | string | ID of the contact | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\nSta"
},
{
"info": {
"name": "Copy Bulk Contacts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://clientapi.benchmarkemail.com/Contact/CopyContacts"
},
"docs": "Copy Bulk Contacts\r\n\r\nBody Parameters (To be passed as a JSON string)\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| TargetListIDs | required | string | Target List ID | \r\n| ContactIDs | required | string | Comma separated list of Contact IDs | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Share Lists with SubAccounts\r\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListID}} | required | string | ID of the list | \r\n| {{ClientIDs}} | required | string | Client ID of the sub-accounts with whom to share | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Descrip"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListID}} | required | string | ID of the list | \r\n\r\n \r\n\r\nPost Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ContactID}} | required | string | IDs of the contact | \r\nGet contact Merge List\r\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListIDs}} | required | string | IDs of the lists | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n| Status | string | 1 if successful, -1 if error | \r\nData"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListIDs}} | required | string | IDs of the lists | \r\n\r\n \r\n\r\nBody Parameters (To be passed as a JSON string)\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| TargetListID | optional"
},
{
"info": {
"name": "Merge contacts into new list",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://clientapi.benchmarkemail.com/Contact/:ListIDs/MergeIntoListNewList",
"params": [
{
"name": "ListIDs",
"value": "",
"type": "path"
}
]
},
"docs": "Merge contacts into new list\r\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListIDs}} | required | string | IDs of the lists | \r\n\r\n \r\n\r\nBody Parameters (To be passed as a JSON string)\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| NewList | required | str"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListIDs}} | required | string | IDs of the lists | \r\n\r\n \r\n\r\nBody Parameters (To be passed as a JSON string)\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| NewList | required | str"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListIDs}} | required | string | IDs of the lists | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n| Status | string | 1 if successful, -1 if error | \r\n| 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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListIDs}} | required | string | IDs of the lists | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n| Status | string | 1 if successful, -1 if error | \r\nErro"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ListIDs}} | required | string | IDs of the lists | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n| Status | string | 1 if successful, -1 if error | \r\nErrorCopy an existing email\r\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ID}} | required | string | ID of the email | \r\n\r\n \r\n\r\nBody Parameters (To be passed as a JSON string)\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| Name | required | string | Nam"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ID}} | required | string | IDs of the email | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n| Status | string | 1 if successful, -1 if error | \r\n| Data | Get a list of contacts\r\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ID}} | required | string | IDs of the email | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n| Status | string | 1 if successful, -1 if error | \r\n| Data | "
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ID}} | required | string | IDs of the email | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n| Status | string | 1 if successful, -1 if error | \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\nQuery String parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| EmailAddress | optional | string | Email Address | \r\n| HTMLContent | optional | string | HTML Content | \r\n| TextContent | optional | string | Text Content | \r\n\r\n \r\n\r\nResponse 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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ID}} | required | string | ID of the email | \r\n\r\n \r\n\r\nBody Parameters (To be passed as a JSON string)\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| Community | required | string | Get a list of contacts\r\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ID}} | required | string | ID of the Email | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n| ID | string | ID | \r\n| CommunityName | string | Com"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| {{ID}} | required | string | ID of the Email | \r\n\r\n \r\n\r\nBody Parameters (To be passed as a JSON string)\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| SubAccount | required | stri"
},
{
"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\nURL parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\n\r\n\r\n| ID | optional | string | ID of the email | \r\n\r\n \r\n\r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n| Status | string | 1 if successful, -1 if error | \r\n| Error | <"
},
{
"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\nQuery String Parameter : \n\n\n\n| Key | \nRequired | \nDescription | \n \n\n\n\n| PageNumber | \noptional | \nPage Number | \n \n\n| PageSize | \noptional | \nNumber of records to show per page | \n \n\n| Filter | \noptional | \nFilter for automation name | \n \n\n| OrderBy | \noptional | \nColumn 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\nURL Parameters\r\n\r\n\r\n\r\n| Key | \r\nRequired | \r\nDescription | \r\n \r\n\r\n\r\n\r\n| {{AutomationID}} | \r\nRequired | \r\nAutomation ID | \r\n \r\n\r\n \r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n| Status | String | 1 if success, -1 if error | \r\n| Error | URL Parameters\r\n\r\n\r\n\r\n| Key | \r\nRequired | \r\nDescription | \r\n \r\n\r\n\r\n\r\n| {{AutomationID}} | \r\nRequired | \r\nAutomation ID\r\n | \r\n\r\n| {{AutomationDetailID}} | \r\nRequired | \r\nAutomation email ID\r\n | \r\n\r\n \r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\n"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | \r\nRequired | \r\nDescription | \r\n \r\n\r\n\r\n\r\n| {{AutomationID}} | \r\nRequired | \r\nAutomation ID\r\n | \r\n\r\n| {{AutomationDetailID}} | \r\nRequired | \r\nAutomation Email ID\r\n | \r\n\r\n \r\nResponse body parameters\r\n\r\n\r\n\r\n| Key | Type | Description | \r\n\r\n\r\nStatus<"
},
{
"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\nURL Parameters\r\n\r\n\r\n\r\n| Key | \r\nRequired | \r\nDescription | \r\n \r\n\r\n\r\n\r\n| {{AutomationID}} | \r\nRequired | \r\nAutomation ID\r\n | \r\n\r\n \r\nBody Parameters (to be encoded as a JSON string)\r\n\r\n\r\n\r\n| Key | \r\nRequired | \r\nDescription | \r\n \r\n\r\n\r\n\r\n| {{Name}} | \r\nRequired | \r\nName 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\nURL body parameter\r\n \r\n \r\n | Parameter | \r\n Type | \r\n Description | \r\n \r\n \r\n | PageNumber | \r\n string | \r\n Page Number | \r\n \r\n \r\n | PageSize | \r\n string | \r\n Number of rows on the page | \r\n \r\n \r\n | OrderBy | \r\n string | \r\n Order By Column | \r\n \r\n \r\n | Filter | \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 \r\n \r\n | Parameter | \r\n Type | \r\n Description | \r\n \r\n \r\n | ID | \r\n string | \r\n ABSplit ID | \r\n \r\n \r\n Response body parameters:\r\n \r\n \r\n | Parameter | \r\n Type | \r\n Description | \r\n \r\n \r\n | Status | \r\n string | \r\n 1 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\nURL parameters:\r\n\r\n\r\n | Parameter | \r\n Type | \r\n Description | \r\n \r\n\r\n | ID | \r\n string | \r\n ABSplit ID | \r\n \r\n \r\nBody Parameters (to be encoded as a JSON string)\r\n\r\n\r\n\r\n| Key | \r\nRequired | \r\nDescription | \r\n \r\n\r\n\r\n\r\n| Status | \r\nRequired | \r\nStatus 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 | Parameter | \n Required | \n Type | \n Description | \n \n \n \n | PageNumber | \n Optional | \n int | \n Page Number | \n \n \n | PageSize | \n Optional | \n int | \n Number of rows on the page | \n \n \n | OrderBy | \n Optional | \n st"
},
{
"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 | Parameter | \n Required | \n Type | \n Description | \n \n \n \n \n | ID | \n Required | \n string | \n Survey ID | \n \n \n | Name | \n Required | \n string | \n Survey Name | \n \n \n \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 | Parameter | \n Required | \n Type | \n Description | \n \n \n \n \n | ID | \n Required | \n string | \n Survey ID | \n \n \n \n\nResponse Body Parameters : \n\n \n \n | Parameter | \n Type | \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\n \n \n | Parameter | \n Required | \n Type | \n Description | \n \n \n \n \n | ID | \n Required | \n string | \n Survey ID | \n \n \n | Status | \n Required | \n string | \n 1 Active, 0 Inactive, 3 Reactivate | Get list of Polls.\nQuery string parameters : \n \n \n | Parameter | \n Required | \n Type | \n Description | \n \n \n | Filter | \n Optional | \n int | \n Filterr | \n \n \n | PageNumber | \n Required | \n int | \n Page Number | \n \n \n | PageSize | \n Required | \n int | \n Numbe"
},
{
"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 | Parameter | \n Required | \n Type | \n Description | \n \n \n | PollID | \n Required | \n string | \n Poll ID | \n \n \nRequest Body Parameters : \n\n \n | Parameter | \n Required | \n Type | \n Description | \n \n \n | Name | \n Required | \n string | \n Name 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 | Parameter | \n Required | \n Type | \n Description | \n \n \n | PollID | \n Required | \n string | \n Poll ID | \n \n \nResponse Body Parameters : \n\n \n | Parameter | \n Type | \n Description | \n \n \n | Response | \n int | \n ID "
},
{
"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 | Parameter | \n Required | \n Type | \n Description | \n \n \n \n \n | PollID | \n Required | \n String | \n Poll ID | \n \n \n \n\nResponse body parameters :\n\n \n \n | Parameter | \n Type | \n "
}
]
}
],
"bundled": true
} | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |