openapi: 3.0.3 info: title: Benchmark Email RESTful API v3.0 description: 'RESTful API for managing email marketing contacts, lists, campaigns, automations, reports, images, and webhooks within the Benchmark Email platform. To use the API, you need a Benchmark Email API token available at https://ui.benchmarkemail.com/Integrate#API. Rate limit: 500 calls per 2 minutes and 60,000 calls per day.' version: 3.0.0 contact: name: Benchmark Email Developer Support url: https://developer.benchmarkemail.com/ license: name: Proprietary servers: - url: https://clientapi.benchmarkemail.com description: Benchmark Email Client API security: - apiKeyAuth: [] components: securitySchemes: apiKeyAuth: type: apiKey in: header name: AuthToken description: API token obtained from https://ui.benchmarkemail.com/Integrate#API paths: /Client/SubAccount: get: tags: - Sub-Account summary: Get Sub-Accounts operationId: get__client_subaccount parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Sub-Accounts

\nQuery string parameters : None\ \
\n\nResponse Body Parameters :\n\n \n \n\ \ \n \n \n\ \ \n \n \n \n \n \n\ \ \n \n \n \n\ \ \n \n \n " post: tags: - Sub-Account summary: Create Sub-Account operationId: post__client_subaccount parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Create Sub-Account

\nURL parameters (to be encoded\ \ as JSON in body) :\n
ParameterTypeDescription
CountStringNumber of Sub-Accounts
DataClientDetail 
\n \n \n \n\ \ \n \n \n\ \ \n \n \n \n \n \ \ \n \n \n \n \n
ParameterRequiredTypeDescription
DetailRequiredSubAccountDetailSub Account\ \ Detail Array
\nResponse Body Parameters\ \ :\n\n \n \n \n
ParameterTypeGet Sub-Account History\nQuery string parameters :\ \ None
\n\nResponse Body Parameters :\n\n \n \ \ \n \n \n \n\ \ \n \n \n \n \n \n\ \ \n \n \n \n \ \ \n \n \n " /Client/SubAccount/{ID}: get: tags: - Sub-Account summary: Get Sub-Account Details operationId: get__client_subaccount__id parameters: - name: ID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Sub-Account Details

\nQuery string parameters :\n\
ParameterTypeDescription
DataClientDate 
Statusstring1 = Successful, -1 Error
\n \n \n \n \n\ \ \n \n \n \n\ \ \n \n \n \n \n\ \ \n \n \n
ParameterRequiredTypeDescription
IDRequiredstringClient ID
\nResponse Body\ \ Parameters :\n\n \n \n \n\ \ \n \n \n Update Sub Account\nQuery String Parameter:\n\
ParameterTypeDescription
\n \n \n \n \n\ \ \n \n \n \n\ \ \n \n \n \n \n\ \ \n \n \n
ParameterRequiredTypeDescription
IDRequiredstringSub Account ID
\nURL parameters\ \ (to be encoded as JSON in body) :\n\n \n \n \ \ \n \n \n " requestBody: content: application/json: schema: type: object /Client/Plan: get: tags: - Sub-Account summary: /Plan | Plan Details & Limits, Get Plan Information operationId: get__client_plan parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Client's Plan Information

\nResponse Body Parameters\ \ :\n
ParameterRequiredType
\n \n \n \n \n\ \ \n \n \n \n \n\ \ \n \n \n \n \n \ \ \n
ParameterTypeDescription
AddonAddonResult 
EmailPlanEmailPlanResult<" /Client/ProfileDetails: get: tags: - Sub-Account summary: Get Profile Details operationId: get__client_profiledetails parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Client's Profile Details

\nResponse Body Parameters\ \ :\n\n \n \n \n \n\ \ \n \n \n \n \n\ \ \n \n \n \n \n\
ParameterTypeDescription
ResponceClientProfileDetailsArray
" /Client/SubAccount/{ID}/Status: patch: tags: - Sub-Account summary: Change Sub-Account status operationId: patch__client_subaccount__id__status parameters: - name: ID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Change Sub-Account status

\nQuery string parameters\ \ : None
\n\nRequest Body parameters:\n\n \n\ \ \n \n \n \n\ \ \n \n \n \n \n\ \ \n \n \n \ \ \n \n \n
ParameterRequiredTypeDescription
StatusRequiredstring1 to activate, 0 to deactivate
\n\ \nResponse body parameters :\n\n \n \n
Parameter<" /Client/SubAccount/History/{HistoryID}: get: tags: - Sub-Account summary: Get Sub-Account history details operationId: get__client_subaccount_history__historyid parameters: - name: HistoryID in: path required: true schema: type: string - name: ID in: query required: false schema: type: string - name: StartDate in: query required: false schema: type: string - name: EndDate in: query required: false schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Sub-Account history details

\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 \n " /Client/SubAccount/{ID}/Balance: get: tags: - Sub-Account summary: Get Sub-Account balance operationId: get__client_subaccount__id__balance parameters: - name: ID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Sub-Account balance

\nQuery string parameters :\n\
ParameterRequiredTypeDescription
IDRequiredstringHistory ID
StartDateRequiredstringBilling cycle start\ \ date
EndDate
\n \n \n \n \n\ \ \n \n \n \n\ \ \n \n \n \n \n\ \ \n \n \n
ParameterRequiredTypeDescription
IDRequiredstringSub-Account holder client ID
\n\ \nResponse body parameters :\n\n \n \n \n\ \ \n " /Client/SubAccount/{ID}/Inbox: post: tags: - Sub-Account summary: Add/Remove inbox tests from Sub-Account operationId: post__client_subaccount__id__inbox parameters: - name: ID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Add/Remove inbox tests from Sub-Account

\nRequest Body\ \ parameters:\n
ParameterTypeDescription
\n \n \n \n\ \ \n \n \n\ \ \n \n \n \n \n \n\ \ \n \n \n\ \ \n \n \n \n\ \ \n \n \n
ParameterRequiredTypeDescription
IDRequiredstringSub-Account holder Client ID
TestsRequiredint 
\n\nResponse " requestBody: content: application/json: schema: type: object /Client/SubAccount/{ID}/PlanList: get: tags: - Sub-Account summary: Get Sub-Accounts plan list operationId: get__client_subaccount__id__planlist parameters: - name: ID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Sub-Accounts plan list

\nRequest Body parameters:\n\ \n \n \n \n \n\ \ \n \n \n \n\ \ \n \n \n \n \n\ \ \n \n \n
ParameterRequiredTypeDescription
IDRequiredstringSub-Account holder client ID
\n\ \nResponse body parameters :\n\n \n \n \n\ \ \n
ParameterTypeDescriptionGet Client Account Settings\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
CompanySettingCompanyDataArray of error
Footer" patch: tags: - Account Settings summary: Update Client Accounts Setting operationId: patch__client_setting parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Update Client Accounts Setting

\nQuery String Parameters\ \ : None
\n\nRequest Body Parameters: \n\n \n\ \ \n \n \n \n\ \ \n \n \n \n \n \ \ \n \n \n\ \ \n \n \n " requestBody: content: application/json: schema: type: object /Client/PIN: post: tags: - Security summary: 'Change Security PIN ' operationId: post__client_pin parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Change Security PIN

\nBody Parameters (to be encoded\ \ as a JSON string)\n
ParameterTypeDescription
CompanySettingCompanyDataSetting Company Data
Languagestring
\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
ResetPINRequiredNew PIN
ResetConfirmPINRequiredConfirm New PIN
ResetOldPINRequiredCurrent PIN
\nResponse\ \ Body Parameters :\n\n \n \n \n\ \ " requestBody: content: application/json: schema: type: object patch: tags: - Security summary: Save Security PIN operationId: patch__client_pin parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Save Security PIN

\nBody Parameters (to be encoded\ \ as a JSON string)\n
Parameter
\n\n\n\n\n\ \n\n\n\n\n\n\n\ \n\n\n\n\n\ \n\n\n
KeyRequiredDescription
NewPINRequiredNew PIN
ConfirmNewPINRequiredConfirm New PIN
\nResponse Body Parameters\ \ :\n\n \n \n \n \n\ \ \n \n \n \n" requestBody: content: application/json: schema: type: object /Client/PIN/Disable: post: tags: - Security summary: Disable Security PIN operationId: post__client_pin_disable parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Disable Security PIN

\nBody Parameters (to be encoded\ \ as a JSON string)\n
ParameterTypeDescription
\n\n\n\n\n\ \n\n\n\n\n\n\ \n\n\n\n
KeyRequiredDescription
DisableOldPINRequiredOld PIN
\nResponse\ \ Body Parameters :\n\n \n \n \n\ \ \n \n \n \n\ \ \n \n \n \n \ \
ParameterTypeDescription
retValstringretu" requestBody: content: application/json: schema: type: object /Client/PIN/Email: post: tags: - Security summary: Send PIN via email incase you forgot operationId: post__client_pin_email parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Send PIN via email incase you forgot

\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\ \ <" /Client/LinkAccount/: post: tags: - Agency Account summary: Link Account operationId: post__client_linkaccount parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Link Account

\nQuery string parameters : None
\n\ \nRequest Body parameters:\n
ParameterTypeDescription
retValstringreturn Value
ErrorErrorDataArray of error
Status
\n \n \n \n\ \ \n \n \n\ \ \n \n \n \n \n \n\ \ \n \n \n \n \ \ \n \n \n \ \ \n \n \n " requestBody: content: application/json: schema: type: object /Client/LinkAccount: get: tags: - Agency Account summary: Get list of link accounts operationId: get__client_linkaccount parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get list of link accounts

\nQuery string parameters\ \ : None
\n\nRequest Body parameters: None
\n\nResponse\ \ body parameters :\n
ParameterRequiredTypeDescription
LoginRequiredstringLogin ID
PasswordRequiredstringFrom Email Address
\n \n \n \n\ \ \n \n \n \n\ \ \n \n \n \n \n \n \n \n \ \
ParameterTypeDescription
CountstringNumber\ \ of link accounts
DataDelete Link Account\nQuery string parameters :\ \ None\n\nRequest Body parameters:\n\n \n \n\ \ \n \n \n\ \ \n \n \n \n \n\ \ \n \n \n \ \ \n \n \n
ParameterRequiredTypeDescription
IDRequiredstringLink Account ID
\n\nResponse\ \ body parameters :\n\n \n \n \n\ \ \n " patch: tags: - Agency Account summary: Update Link Account operationId: patch__client_linkaccount__id parameters: - name: ID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Update Link Account

\nQuery string parameters :\ \ None
\n\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 \n \ \ \n \n Get Link Account Details\nQuery string parameters\ \ : None\n\nRequest Body parameters:\n
ParameterRequiredTypeDescription
IDRequiredstringLink Account ID
LoginRequiredstringLogin ID
\n \n \n\ \ \n \n \n\ \ \n \n \n \n \n\ \ \n \n \n \ \ \n \n \n
ParameterRequiredTypeDescription
IDRequiredstringLink Account ID
\n\nResponse\ \ body parameters :\n\n \n \n \n\ \ \n" /Client/Password: patch: tags: - Account Settings summary: Change Password operationId: patch__client_password parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Change Password

\nBody Parameters (to be encoded as\ \ a JSON string)\n
ParameterType
\n\n\n\n\n\ \n\n\n\n\n\n\ \n\n\n\n\n\ \n\n\n\n
KeyRequiredDescription
NewPasswordRequiredNew Password
ConfirmPasswordRequiredConfirm Password
\n\ Response Body Parameters :\n\n \n \n \n\ \ \n \n \n " requestBody: content: application/json: schema: type: object /Client/Email/ResetLink: patch: tags: - Account Settings summary: Send Reset Email operationId: patch__client_email_resetlink parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Send Reset Email to change primary email

\nResponse\ \ Body Parameters :\n
ParameterTypeDescription
\n \n \n \n\ \ \n \n \n \n\ \ \n \n \n \n \ \ \n \n \n \n \ \ \n\ \ \n \n \n \n\ \ " /Client/ConfirmedEmail/All: get: tags: - Account Settings summary: Get All Confirmed Email operationId: get__client_confirmedemail_all parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get All Confirmed Email

\nQuery string parameters :\ \ None
\n\nRequest Body parameters: None
\n\nResponse body\ \ parameters :\n
ParameterTypeDescription
retValstringreturn Value
ErrorErrorDataArray of error
Status
\n \n \n \n\ \ \n \n \n \n\ \ \n \n \n \n \n \n \n \n
ParameterTypeDescription
CountstringTotal\ \ Confirmed Emails
DataSend Confirm Email Verification Email\nQuery string\ \ parameters : None
\n\nRequest Body parameters: \n\n\ \ \n \n \n \n\ \ \n \n \n \n\ \ \n \n \n \n \ \ \n \n \n \n\
ParameterRequiredTypeDescription
EmailIDsRequiredstringEmail Address
\nResponse body parameters :\n\n \n \n\ \
ParameterGet List of Confirmed Emails\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 \n \ \
ParameterTypeDescription
EmailsstringList of Emails
ErrorErrorDataGet Current email at the time of Reset Email Query String Parameter :
Key Required Description
GUID optional Unique ID
Response body parameters
KeyTypeDescription
EmailStringEmail Address
StatusString1 if success, -1' patch: tags: - Account Settings summary: 'Update/Reset Email ' operationId: patch__client_email_reset parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Reset primary email

\r\nURL Parameters (To be encoded\ \ as JSON 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
KeyRequiredDescription
GUIDRequiredThe ID which is available\ \ on the email link send for reset the email\r\n
NewEmailRequiredNew Email\r\n
ConfirmEmailRequiredConfirm Email\r\n
\r\ \nResponse bo" requestBody: content: application/json: schema: type: object /Client/: patch: tags: - Account Settings summary: Update/Edit Profile operationId: patch__client parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Update/Edit Profile like first name,phone no etc

\r\n\ URL Parameters (To be encoded as JSON 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
KeyRequiredDescription
FirstNameRequiredFirst Name\r\n
LastNameRequiredLast Name\r\n
PhoneNoRequiredPhone Number\r\n
\r\nResponse body\ \ parameters\r\n\r\nGet Client Details\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
ResponseProfileDataClient Profile data
" /Client/Token/{Type}: get: tags: - Account Settings summary: Get Token operationId: get__client_token__type parameters: - name: Type in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Token

\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 \n \n \n \n \n \n \n\ \ " /Client/Token: post: tags: - Account Settings summary: Generate Token operationId: post__client_token parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Generate Token

\nQuery String Parameters : None\ \
\n\nRequest Body Parameters: None
\n\nResponse Body Parameters\ \ :\n
ParameterTypeDescription
AuthURLstringAuth URL
NamestringClient\ \ Name
Secretstring
\n \n \n \n \n\ \ \n \n \n \n \n\ \ \n \n \n \n\ \ \n
ParameterTypeDescription
retValstringToken
" /Client/Token/{Type}/Detail: get: tags: - Account Settings summary: Get Token Details operationId: get__client_token__type__detail parameters: - name: Type in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description:

Get Token Details

/Client/FilterDomain: get: tags: - Account Settings summary: Get Client Filter Domain operationId: get__client_filterdomain parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Client Filter 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 \n
ParameterTypeDescription
CountstringNumber\ \ of Domains
DataClientFilt" /Client/InitSurvey: post: tags: - Account Settings summary: Save Website Domain operationId: post__client_initsurvey parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: '

Provide your domain name to link it to your account

Response Body Parameters :
Parameter Required Type Description
CompanyWebsite Required String Company Website like BobsVacations.com
' requestBody: content: application/json: schema: type: object /Client/ConfirmedEmail/{Email}: get: tags: - Account Settings summary: Resend Confirm Email operationId: get__client_confirmedemail__email parameters: - name: Email in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Resend Confirm Email

\nQuery string parameters :\ \ None
\n\nRequest Body parameters: \n\n \n \n\ \ \n \n \n\ \ \n \n \n \n \n\ \ \n \n \n \ \ \n \n \n
ParameterRequiredTypeDescription
EmailRequiredstringEmail ID
\nResponse body\ \ parameters :\n\n \n \n \n\ \ \n " /Client/Notification: get: tags: - General summary: Get Notification operationId: get__client_notification parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Notification

\nResponse body parameters :\n\
ParameterType
\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<" patch: tags: - General summary: Set Responsive operationId: patch__client_responsive parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

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
\n\ Response 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
" /Client/Archive/Domain: get: tags: - General summary: Get Archive Domain Name operationId: get__client_archive_domain parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

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
" /Client/Community/Domain: get: tags: - General summary: Get Community Domain operationId: get__client_community_domain parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

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
" /Client/DMarc: get: tags: - General summary: Get DMARC List operationId: get__client_dmarc parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

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
" /Client/ListUploadTerms: get: tags: - General summary: Get List Upload Terms operationId: get__client_listuploadterms parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

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<" /Contact/: post: tags: - List Configurations & Searches summary: / | Create new List, Create List operationId: post__contact parameters: [] responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

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" requestBody: content: application/json: schema: type: object get: tags: - List Configurations & Searches summary: / | All lists or filter for a list, Get a list of contacts operationId: get__contact parameters: - name: Status in: query required: false schema: type: string - name: PageNumber in: query required: false schema: type: string - name: PageSize in: query required: false schema: type: string - name: SearchFilter in: query required: false schema: type: string - name: OrderBy in: query required: false schema: type: string - name: SortOrder in: query required: false schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get a list of contacts

\r\n\r\n

Query String parameters

\r\ \n
KeyTypeDescription
\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,\ \ " /Contact/{ListID}: get: tags: - List Configurations & Searches summary: /{{ListID}} | Deep View, Get contact lists detail operationId: get__contact__listid parameters: - name: ListID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get contact lists detail

\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
Da" delete: tags: - List Configurations & Searches summary: /{{ListID}} || Delete list operationId: delete__contact__listid parameters: - name: ListID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

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<" patch: tags: - General summary: Modify Contact List operationId: patch__contact__listid parameters: - name: ListID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "Modifies an existing contact list\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\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 Get contact lists attributes\r\n

URL Parameters

\r\ \n
KeyRequiredDescription
NameoptionalList\ \ Name
\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" /Contact/DeleteListCheck/{ListIDs}: get: tags: - List Configurations & Searches summary: Delete List Check operationId: get__contact_deletelistcheck__listids parameters: - name: ListIDs in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

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" /Contact/{ListID}/ContactDetails: get: tags: - Contact Configurations & Searches summary: /{{ListID}}/ContactDetails? | Search a List, Get Filtered Contacts operationId: get__contact__listid__contactdetails parameters: - name: ListID in: path required: true schema: type: string - name: SearchType in: query required: false schema: type: string - name: SearchField in: query required: false schema: type: string - name: SearchFilter in: query required: false schema: type: string - name: PageNumber in: query required: false schema: type: string - name: PageSize in: query required: false schema: type: string - name: OrderBy in: query required: false schema: type: string - name: SortOrder in: query required: false schema: type: string - name: Filter in: query required: false schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Filtered 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

Query String parameters

\r\ \n\r\n\r\n\r\n\r\ \n\r\n\r\n
KeyRequiredTypeDescription
SearchFilteroptionalstring\ \ Search valueAdd Contact\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
DatarequiredSearch Contacts\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
SearchFilteroptionalstring\ \ Search Filter
Searchrequiredstring\ \ Email Address you want to search
\r\ \n\r\n

Response body parameters

\r\n\r\n\r\n\r\n\ \r\n" delete: tags: - General summary: Delete the selected contacts from current lists operationId: delete__contact_contactdetails parameters: - name: Search in: query required: false schema: type: string - name: Filter in: query required: false schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Delete the selected contacts from current lists

\r\n\

Request body parameters

\r\n
KeyTypeDescription
\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<" /Contact/{ListID}/ContactDetails/{ContactID}: get: tags: - Contact Configurations & Searches summary: /{{ListID}}/ContactDetails/{{ContactID}} | Show a contact field names valuesand rating , Contact Details operationId: get__contact__listid__contactdetails__contactid parameters: - name: ListID in: path required: true schema: type: string - name: ContactID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Contact Details

\r\n

URL Parameters

\r\n
Key
\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\nUpdate Contact\r\n

URL Parameters

\r\n
KeyTypeDescription
\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

Body Parameters\ \ (To be passed as a JSON string)

\r\n\r\n\r\n\r\n
KeyRequiredTypeDescriptionDelete the selected contacts from ALL lists\r\n\r\n

Request\ \ body parameters

\r\n\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
Key" /Contact/{ListID}/ContactDetails/CSV/Upload: post: tags: - Add Contacts summary: '{{ListID}}/ContactDetails/CSV/Upload |Save email address which are not verified and uploaded' operationId: post__contact__listid__contactdetails_csv_upload parameters: - name: ListID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Save email address which are not verified and uploaded

\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
ListIDrequiredstringID\ \ 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
Datare" /Contact/{ListID}/Mapping: patch: tags: - Add Contacts summary: /{{ListID}}/Mapping | Change mapping operationId: patch__contact__listid__mapping parameters: - name: ListID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Changes file mapping

\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 encoded as a JSON string)

\r\n\r\n\r\n\r\n\ \r\n\r\ \n\r\n<" requestBody: content: application/json: schema: type: object /Contact/{ListID}/Compilation: patch: tags: - Add Contacts summary: /{{ListID}}/Compilation | Changing list compilation details operationId: patch__contact__listid__compilation parameters: - name: ListID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Changes file upload compilation

\r\n

URL Parameters

\r\ \n
KeyRequiredTypeDescription
FileNamerequiredstring
\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 encoded as a JSON string)

\r\n\r\n\r\n\r\n\ \r\n\r\ \n\r\nURL Parameters\r\n
KeyRequiredTypeDescription
Descriptionrequired
\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
KeyRequiredDescription
{{ListID}}requiredID of the list
{{FileName}}requiredName\ \ of the file
\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<" /Contact/{ListID}/ContactDetails/CSV: post: tags: - Add Contacts summary: Save email address operationId: post__contact__listid__contactdetails_csv parameters: - name: ListID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Save email address

\r\n

URL Parameters

\r\n
KeyTypeDescription
\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\nSave email address which verified\r\n

URL Parameters

\r\ \n
KeyRequiredTypeDescription
EmailIDsrequiredstring
\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
EmailIDsrequired" requestBody: content: application/json: schema: type: object /Contact/{ID}/ContactDetails/CSV/Upload/Verified: post: tags: - Add Contacts summary: Save email address which is verified and uploaded operationId: post__contact__id__contactdetails_csv_upload_verified parameters: - name: ID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Save email address which is verified and uploaded

\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
ListIDrequiredstringID\ \ 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
Datarequire" requestBody: content: multipart/form-data: schema: type: object /Contact/{ListID}/ContactSummary: get: tags: - List Reporting or Metrics summary: /{{ListID}}/ContactSummary || Send Performance, Get the contact summary operationId: get__contact__listid__contactsummary parameters: - name: ListID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: 'Get summary details of a contact list

URL Parameters

Key Required Description
{{ListID}} required ID of the contact list

Response body parameters

KeyTypeDescription
Statusstring1 if successful, -1 if error
DataContactSummaryRecord<' /Contact/{ListID}/CleanCount: get: tags: - List Reporting or Metrics summary: 'Get the clean count ' operationId: get__contact__listid__cleancount parameters: - name: ListID in: path required: true schema: type: string - name: ct in: query required: false schema: type: string - name: ctc in: query required: false schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "Gets the clean count\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 ID
\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\r\n\r\n\r\n\r\ \n\r\n\r\n" /Contact/{ID}/Download: get: tags: - List Reporting or Metrics summary: Get Download report operationId: get__contact__id__download parameters: - name: ID in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get a list of contacts

\r\n

URL Parameters

\r\n\
KeyRequiredDescription
ctrequiredClean Type
ctcrequired
\r\n\r\n\r\n\r\ \n\r\n\r\n\r\n\r\n
KeyRequiredTypeDescription
{{ID}}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 error
ListNameDownload report\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 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" /Contact/Count/{ListIDs}/{SegmentIDs}: get: tags: - List Reporting or Metrics summary: /Count/{{ListIDs}}/{{SegmentIDs}} ||Get Contacts Count operationId: get__contact_count__listids___segmentids parameters: - name: ListIDs in: path required: true schema: type: string - name: SegmentIDs in: path required: true schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "

Get Contacts Count

\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
{{ListIDs}}requiredstringIDs\ \ of the lists
{{SegmentIDs}}requiredstringIDs\ \ of the segments
\r\n\r\n

Query String\ \ parameters

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

Response body parameters

\r\ \n
KeyRequiredTypeDescription
\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 count
" /Contact/ExportToList: get: tags: - List Reporting or Metrics summary: /ExportToList? | Engagement Reporting, Get Export List operationId: get__contact_exporttolist parameters: - name: ReportFor in: query required: false schema: type: string - name: EmailID in: query required: false schema: type: string - name: IsOverWrite in: query required: false schema: type: string responses: '200': description: Successful response '400': description: Bad request '401': description: Unauthorized '404': description: Not found description: "Export List\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\r\n\r\ \n
KeyRequiredDescription
ReportForoptional