\n \
\ | EmailPlan | \n EmailPlanResult<"
/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 | Parameter | \n Type | \n\
\ Description | \n \n \n \n \n\
\ | Responce | \n ClientProfileDetails | \n Array | \n \n \n\
"
/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 | Parameter | \n Required | \n Type | \n\
\ Description | \n \n \n \n \n\
\ | Status | \n Required | \n string | \n \
\ 1 to activate, 0 to deactivate | \n \n \n \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 | Parameter | \n Required | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | ID | \n Required | \n string | \n\
\ History ID | \n \n \n | StartDate | \n\
\ Required | \n string | \n Billing cycle start\
\ date | \n \n \n | EndDate | \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\
\n \n \n | Parameter | \n Required | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | ID | \n Required | \n string | \n\
\ Sub-Account holder client ID | \n \n \n \n\
\nResponse body parameters :\n\n \n \n | Parameter | \n\
\ Type | \n Description | "
/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\n \n \n | Parameter | \n\
\ Required | \n Type | \n Description | \n\
\ \n \n \n \n | ID | \n Required | \n\
\ string | \n Sub-Account holder Client ID | \n \n\
\ \n | Tests | \n Required | \n int | \n\
\ | \n \n \n \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 | Parameter | \n Required | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | ID | \n Required | \n string | \n\
\ Sub-Account holder client ID | \n \n \n \n\
\nResponse body parameters :\n\n \n \n | Parameter | \n\
\ Type | \n DescriptionGet Client Account Settings\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 | Company | \n SettingCompanyData | \n Array of error | \n \n\
\ \n 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 | Parameter | \n Type | \n Description | \n\
\ \n \n \n \n | Company | \n \
\ SettingCompanyData | \n Setting Company Data | \n \n\
\ \n | Language | \n string | \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\n\n\n| Key | \nRequired | \n\
Description | \n \n\n\n\n| ResetPIN | \n\
Required | \nNew PIN | \n \n\n| ResetConfirmPIN | \n\
Required | \nConfirm New PIN | \n \n\n| ResetOldPIN | \n\
Required | \nCurrent PIN | \n \n\n \nResponse\
\ Body Parameters :\n\n \n \n | Parameter | \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\n\n\n| Key | \nRequired | \n\
Description | \n \n\n\n\n| NewPIN | \nRequired | \n\
New PIN | \n \n\n| ConfirmNewPIN | \nRequired | \n\
Confirm New PIN | \n \n\n \nResponse Body Parameters\
\ :\n\n \n \n | Parameter | \n Type | \n\
\ Description | \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\n\n\n| Key | \nRequired | \n\
Description | \n \n\n\n\n| DisableOldPIN | \n\
Required | \nOld PIN | \n \n\n \nResponse\
\ Body Parameters :\n\n \n \n | Parameter | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | retVal | \n string | \n \
\ retu"
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 | Parameter | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | retVal | \n string | \n \
\ return Value | \n \n \n | Error | \n \
\ ErrorData | \n\
\ Array of error | \n \n \n | Status | \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\n \n \n | Parameter | \n\
\ Required | \n Type | \n Description | \n\
\ \n \n \n \n | Login | \n Required | \n\
\ string | \n Login ID | \n \n \n \
\ | Password | \n Required | \n string | \n \
\ From Email Address | \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\n \n \n | Parameter | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | Count | \n string | \n Number\
\ of link accounts | \n \n \n | Data | \n \
\ Delete Link Account\nQuery string parameters :\
\ None\n\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 \
\ Link Account ID | \n \n \n \n\nResponse\
\ body parameters :\n\n \n \n | Parameter | \n\
\ Type | \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\n \n \n\
\ | Parameter | \n Required | \n Type | \n\
\ Description | \n \n \n \n \n\
\ | ID | \n Required | \n string | \n \
\ Link Account ID | \n \n \n | Login | \n \
\ Required | \n string | \n Login ID | \n \
\ \n \n Get Link Account Details\nQuery string parameters\
\ : None\n\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 \
\ Link Account ID | \n \n \n \n\nResponse\
\ body parameters :\n\n \n \n | Parameter | \n\
\ Type | \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\n\n\n| Key | \nRequired | \n\
Description | \n \n\n\n\n| NewPassword | \n\
Required | \nNew Password | \n \n\n| ConfirmPassword | \n\
Required | \nConfirm Password | \n \n\n \n\
Response Body Parameters :\n\n \n \n | Parameter | \n\
\ Type | \n Description | \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\n \n \n | Parameter | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | retVal | \n string | \n \
\ return Value | \n \n \n | Error | \n \
\ ErrorData | \n\
\ Array of error | \n \n \n | Status | \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\n \n \n | Parameter | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | Count | \n string | \n Total\
\ Confirmed Emails | \n \n \n | Data | \n Send Confirm Email Verification Email\nQuery string\
\ parameters : None \n\nRequest Body parameters: \n\n\
\ \n \n | Parameter | \n Required | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | EmailIDs | \n Required | \n \
\ string | \n Email Address | \n \n \n\
\nResponse body parameters :\n\n \n \n\
\ | Parameter | Get List of Confirmed Emails\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 | Emails | \n string | \n \
\ List of Emails | \n \n \n | Error | \n \
\ ErrorDataGet Current email at the time of Reset Email
Query String Parameter :
| Key |
Required |
Description |
| GUID |
optional |
Unique ID |
Response body parameters
| Key | Type | Description |
| Email | String | Email Address |
| Status | String | 1 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| Key | \r\n\
Required | \r\nDescription | \r\n \r\n\r\n\r\
\n\r\n| GUID | \r\nRequired | \r\nThe ID which is available\
\ on the email link send for reset the email\r\n | \r\n\r\n| NewEmail | \r\
\nRequired | \r\nNew Email\r\n | \r\n\r\n| ConfirmEmail | \r\
\nRequired | \r\nConfirm Email\r\n | \r\n\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| Key | \r\nRequired | \r\nDescription | \r\n \r\
\n\r\n\r\n\r\n| FirstName | \r\nRequired | \r\
\nFirst Name\r\n | \r\n\r\n| LastName | \r\nRequired | \r\
\nLast Name\r\n | \r\n\r\n| PhoneNo | \r\nRequired | \r\
\nPhone Number\r\n | \r\n\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 | Parameter | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | Response | \n ProfileData | \n Client Profile data | \n \n \
\ \n "
/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 | Parameter | \n Type | \n\
\ Description | \n \n \n \n \n\
\ | AuthURL | \n string | \n Auth URL | \n\
\ \n \n | Name | \n string | \n Client\
\ Name | \n \n \n | Secret | \n string | \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\n \n \n | Parameter | \n Type | \n\
\ Description | \n \n \n \n \n\
\ | retVal | \n string | \n Token | \n \n\
\ \n "
/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 | Parameter | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | Count | \n string | \n Number\
\ of Domains | \n \n \n | Data | \n ClientFilt"
/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\
\ | Parameter | \n Required | \n Type | \n\
\ Description | \n \n \n \n \n\
\ | Email | \n Required | \n string | \n \
\ Email ID | \n \n \n \nResponse body\
\ parameters :\n\n \n \n | Parameter | \n\
\ Type | \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\
\n \n \n | Parameter | \n Type | \n\
\ Description | \n \n \n \n \n\
\ | Data | \n NotificationData | \n Array | \n \n \n\
\ | Errors | \n ErrorData | \n Array"
/Client/Responsive:
get:
tags:
- General
summary: Check if Responsive
operationId: get__client_responsive
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "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<"
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| Key | \nRequired | \n\
Description | \n \n\n\n\n| IsResponsive | \n\
Required | \nIs Responsive=1,Not = 0 | \n \n\n \n\
Response 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 "
/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 | Parameter | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | DomainName | \n string | \n \
\ Domain Name | \n \n \n "
/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 | Parameter | \n\
\ Type | \n Description | \n \n \n\
\ \n \n | DomainName | \n string | \n \
\ Domain Name | \n \n \n "
/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 | Parameter | \n Type | \n\
\ Description | \n \n \n \n \n\
\ | Data | \n GenericList | \n Generic List | \n \n \n\
"
/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 | 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\
\ <"
/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\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| Data | required | ContactMasterRecord | List\
\ Details | \r\n\r\n \r\n\r\nResponse body parameters\r\
\n\r\n\r\n\r\n| Key | Type | Description | \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\nQuery String parameters\r\
\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\
\n\r\n\r\n| PageNumber | optional | int | Page\
\ number | \r\n| PageSize | optional | int | Number\
\ of records to show per page | \r\n| OrderBy | optional | string | Field\
\ 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\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\nDa"
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\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 | <"
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\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 | "
/Contact/{ListID}/Fields:
get:
tags:
- List Configurations & Searches
summary: /{{ListID}}/Fields | Field Names, Get contact lists attributes
operationId: get__contact__listid__fields
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 attributes\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\nGet contact lists\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| Data | "
/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\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"
/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\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\nQuery String parameters\r\
\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\
\n\r\n\r\n| SearchFilter | optional | string\
\ | Search value | Add Contact\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| Data | required | Search Contacts\r\nQuery String parameters\r\
\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\
\n\r\n\r\n| SearchFilter | optional | string\
\ | Search Filter | \r\n| Search | required | string\
\ | Email Address you want to search | \r\n\r\n \r\
\n\r\nResponse body parameters\r\n\r\n\r\n\r\n\
| Key | Type | Description | \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\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 | <"
/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\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 | Description | \r\
\n\r\n\r\nUpdate Contact\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\nBody Parameters\
\ (To be passed as a JSON string)\r\n\r\n\r\n\r\n| Key | Required | Type | Description"
requestBody:
content:
application/json:
schema:
type: object
/Contact/ContactDetails/All:
delete:
tags:
- Contact Configurations & Searches
summary: /ContactDetails/All | Delete the selected contacts from ALL lists
operationId: delete__contact_contactdetails_all
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "Delete the selected contacts from ALL lists\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 | 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 | "
/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\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| Data | re"
/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\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 encoded as a JSON string)\r\n\r\n\r\n\r\n\
| Key | Required | Type | Description | \r\n\r\
\n\r\n| FileName | required | string | <"
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\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 encoded as a JSON string)\r\n\r\n\r\n\r\n\
| Key | Required | Type | Description | \r\n\r\
\n\r\n| Description | required | URL Parameters\r\n\r\n\r\n\r\n| Key | \r\n\
Required | \r\nDescription | \r\n \r\n\r\n\r\
\n\r\n| {{ListID}} | \r\nrequired | \r\nID of the list | \r\
\n \r\n\r\n| {{FileName}} | \r\nrequired | \r\nName\
\ of the file | \r\n \r\n\r\n \r\n\r\nResponse body\
\ parameters\r\n\r\n\r\n\r\n| Key | \r\nType | \r\
\nDescription | \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\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| EmailIDs | required | string | Save email address which verified\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| EmailIDs | required | "
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\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| Data | require"
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
| Key | Type | Description |
| Status | string | 1 if successful, -1 if error |
| Data | ContactSummaryRecord<'
/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\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 ID | \r\n \r\n\r\n \r\n\r\nQuery\
\ String Parameters\r\n\r\n\r\n\r\n| Key | \r\n\
Required | \r\nDescription | \r\n \r\n\r\n\r\
\n\r\n| ct | \r\nrequired | \r\nClean Type | \r\n \r\
\n\r\n| ctc | \r\nrequired | "
/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\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 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 error | \r\n| ListName | 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"
/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\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| {{SegmentIDs}} | required | string | IDs\
\ of the segments | \r\n\r\n \r\n\r\nQuery String\
\ parameters\r\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\
\nGet a list of contacts\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| Count | int | Total count | \r\
\n\r\n "
/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\nQuery String Parameters\r\n\r\
\n\r\n\r\n| Key | \r\nRequired | \r\nDescription | \r\
\n \r\n\r\n\r\n\r\n| ReportFor | \r\noptional | \r\
\n1 - Clicks2 - Forwards3\
\ - Bounces5 - Unsubscribe6 -\
\ Opens7 - Unopens8 – Clicks For\
\ url11 - Individual SurveyGet Contact Import Status\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| ImportType | string | Import\
\ Type | \r\n| ContactFound | string | Contact Found\
\ Count | \r\n| ContactIncrease | string | | \r\
\n| Count | int | Total count | "
/Contact/{ListID}/AuditHistory:
get:
tags:
- List Reporting or Metrics
summary: /{{ListID}}/AuditHistory || Get contact audit history
operationId: get__contact__listid__audithistory
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 audit history\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\nQuery String parameters\r\
\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\
\n\r\n\r\n| PageNumber | optional | int | Page\
\ number | "
/Contact/{ListID}/AuditHistoryDetails/{BatchID}/{GroupID}:
get:
tags:
- List Reporting or Metrics
summary: Get contact audit history detail
operationId: get__contact__listid__audithistorydetails__batchid___groupid
parameters:
- name: ListID
in: path
required: true
schema:
type: string
- name: BatchID
in: path
required: true
schema:
type: string
- name: GroupID
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: " see /{{ListID}}/AuditHistory || Get contact audit history\
\ - to get BatchID\r\nGet contact audit history detail\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| {{BatchID}} | required | string | ID\
\ of the batch | \r\n| {{GroupID}} | required | string | ID"
/Contact/ActiveCount:
get:
tags:
- Contact Reports & Metrics
summary: /ActiveCount | Total all active emails by account, Get ActiveCount
operationId: get__contact_activecount
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "Get ActiveCount\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| Count | int | Total count | \r\
\n\r\n "
/Contact/{ContactEmail}/ContactReportHistory:
get:
tags:
- Contact Reports & Metrics
summary: /{{ContactEmail}}/ContactReportHistory || Engagement by a Contact,
Get contact history
operationId: get__contact__contactemail__contactreporthistory
parameters:
- name: ContactEmail
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 history\r\nURL Parameters\r\n\r\
\n\r\n\r\n| Key | Required | Type | Description | \r\
\n\r\n\r\n| {{EMail}} | required | string | EMail\
\ Address | \r\n\r\n \r\n\r\nQuery String parameters\r\
\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\
\n\r\n\r\n| PageNumber | optional | int | Page\
\ number | \r\nGet contact history\r\nURL Parameters\r\n\r\
\n\r\n\r\n| Key | Required | Type | Description | \r\
\n\r\n\r\n| {{EMailID}} | required | string | EMail\
\ Address | \r\n\r\n \r\n\r\nQuery String parameters\r\
\n\r\n\r\n\r\n| Key | Required | Type | Description | \r\
\n\r\n\r\n| PageNumber | optional | int | Page\
\ number | \r\n<"
/Contact/UniqueCount:
get:
tags:
- Contact Reports & Metrics
summary: /UniqueCount || Get UniqueCount
operationId: get__contact_uniquecount
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "Get UniqueCount\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| Count | int | Total count | \r\
\n\r\n "
/Contact/{ListID}/Webhooks/{ID}:
patch:
tags:
- Webhooks
summary: Update Webhook
operationId: patch__contact__listid__webhooks__id
parameters:
- name: ListID
in: path
required: true
schema:
type: string
- 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 webhook data\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| {{ID}} | required | string | ID\
\ of the webhook | \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 | DescriptionDelete webhooks\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| {{ID}} | required | string | ID\
\ of the webhook | \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"
/Contact/{ListID}/Webhooks:
post:
tags:
- Webhooks
summary: Create Webhook
operationId: post__contact__listid__webhooks
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: "Create New Webhook\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| Data | required | Get a list of webhooks in the specified 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 | "
/Contact/{ListIDs}/Compare:
get:
tags:
- General
summary: Compare contacts
operationId: get__contact__listids__compare
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: 'Compares contacts
Response: 1 if successful, -1 if error
URL Parameters
| Key |
Required |
Description |
| {{ListIDs}} |
required |
IDs of the lists |
Response body parameters
| Key | Type | Description |
| Status | string | 1 if successful, -1 if error |
'
/Contact/{CleanListID}/Clean:
post:
tags:
- General
summary: Clean List
operationId: post__contact__cleanlistid__clean
parameters:
- name: CleanListID
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: 'Cleans the specified list
URL Parameters
| Key |
Required |
Description |
| {{CleanListID}} |
required |
ID of the contact list to be cleaned |
Body Parameters (to be encoded as a JSON string)
| Key |
Required |
Description |
| HardBounces |
required |
1 if hard bounces are to be clean'
requestBody:
content:
application/json:
schema:
type: object
/Contact/{ListID}/Trash:
delete:
tags:
- General
summary: Delete Trash List
operationId: delete__contact__listid__trash
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 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"
/Contact/{ListID}/ContactDetails/All/{ContactID}:
delete:
tags:
- General
summary: 'Delete the selected contacts from ALL lists from Contact Details page '
operationId: delete__contact__listid__contactdetails_all__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: "Delete the selected contacts from ALL lists from Contact Details\
\ page \r\nURL Parameters\r\n | | | | | |
| | | | | | | | | | | | | | | | | | | | | | | | | |