Benchmark Email RESTful API v3.0
RESTful API for managing email marketing contacts, lists, campaigns, automations, reports, images, and webhooks within the Benchmark Email platform.
OpenAPI Specification
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: "<h4>Get Sub-Accounts</h4>\n<b>Query string parameters :</b> None\
\ <br>\n\n<b>Response Body Parameters :</b>\n<table>\n <thead>\n <tr>\n\
\ <th>Parameter</th>\n <th>Type</th>\n <th>Description</th>\n\
\ </tr>\n </thead>\n <tbody>\n <tr>\n <td>Count</td>\n <td>String</td>\n\
\ <td>Number of Sub-Accounts</td>\n </tr>\n <tr>\n <td>Data</td>\n\
\ <td><a href=\"http://www.benchmarkemail.com/models.htm#ClientDetail\"\
\ >ClientDetail</a></td>\n <td> </td>\n </tr>\n <tr>"
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: "<h4>Create Sub-Account</h4>\n<b>URL parameters (to be encoded\
\ as JSON in body) :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Required</th>\n <th>Type</th>\n <th>Description</th>\n\
\ </tr>\n </thead>\n <tbody>\n <tr>\n <td>Detail</td>\n \
\ <td>Required</td>\n <td>SubAccountDetail</td>\n <td>Sub Account\
\ Detail Array</td>\n </tr>\n </tbody>\n</table>\n<b>Response Body Parameters\
\ :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Type</th"
requestBody:
content:
application/json:
schema:
type: object
/Client/SubAccount/History:
get:
tags:
- Sub-Account
summary: Get Sub-Account History
operationId: get__client_subaccount_history
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "<h4>Get Sub-Account History</h4>\n<b>Query string parameters :</b>\
\ None <br>\n\n<b>Response Body Parameters :</b>\n<table>\n <thead>\n \
\ <tr>\n <th>Parameter</th>\n <th>Type</th>\n <th>Description</th>\n\
\ </tr>\n </thead>\n <tbody>\n <tr>\n <td>Data</td>\n <td><a\
\ href=\"http://www.benchmarkemail.com/models.htm#ClientDate\" >ClientDate</a></td>\n\
\ <td> </td>\n </tr>\n <tr>\n <td>Status</td>\n \
\ <td>string</td>\n <td>1 = Successful, -1 Error</td>\n </tr>\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: "<h4>Get Sub-Account Details</h4>\n<b>Query string parameters :</b>\n\
<table>\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Required</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>ID</td>\n <td>Required</td>\n <td>string</td>\n\
\ <td>Client ID</td>\n </tr>\n </tbody>\n</table>\n<b>Response Body\
\ Parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead"
patch:
tags:
- Sub-Account
summary: Update Sub Account
operationId: patch__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: "<h4>Update Sub Account</h4>\n<b>Query String Parameter:</b>\n\
<table>\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Required</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>ID</td>\n <td>Required</td>\n <td>string</td>\n\
\ <td>Sub Account ID</td>\n </tr>\n </tbody>\n</table>\n<b>URL parameters\
\ (to be encoded as JSON in body) :</b>\n<table>\n <thead>\n <tr>\n \
\ <th>Parameter</th>\n <th>Required</th>\n <th>Type</th>\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: "<h4>Get Client's Plan Information</h4>\n<b>Response Body Parameters\
\ :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Type</th>\n\
\ <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n\
\ <td>Addon</td>\n <td><a href=\"http://www.benchmarkemail.com/models.htm#ClientAddonResult\"\
\ >AddonResult</a></td>\n <td> </td>\n </tr>\n <tr>\n \
\ <td>EmailPlan</td>\n <td><a href=\"http://www.benchmarkemail.com/models.htm#ClientEmailPlanResult\"\
\ >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: "<h4>Get Client's Profile Details</h4>\n<b>Response Body Parameters\
\ :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Type</th>\n\
\ <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n\
\ <td>Responce</td>\n <td><a href=\"http://www.benchmarkemail.com/models.htm#ClientProfileDetails\"\
\ >ClientProfileDetails</a></td>\n <td>Array</td>\n </tr>\n </tbody>\n\
</table>"
/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: "<h4>Change Sub-Account status</h4>\n<b>Query string parameters\
\ :</b> None <br>\n\n<b>Request Body parameters:</b>\n<table>\n <thead>\n\
\ <tr>\n <th>Parameter</th>\n <th>Required</th>\n <th>Type</th>\n\
\ <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n\
\ <td>Status</td>\n <td>Required</td>\n <td>string</td>\n \
\ <td>1 to activate, 0 to deactivate</td>\n </tr>\n </tbody>\n</table>\n\
\n<b>Response body parameters :</b>\n<table>\n <thead>\n <tr>\n <th>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: "<h4>Get Sub-Account history details</h4>\n<b>Query string parameters\
\ :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Required</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>ID</td>\n <td>Required</td>\n <td>string</td>\n\
\ <td>History ID</td>\n </tr>\n <tr>\n <td>StartDate</td>\n\
\ <td>Required</td>\n <td>string</td>\n <td>Billing cycle start\
\ date</td>\n </tr>\n <tr>\n <td>EndDate</td>\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: "<h4>Get Sub-Account balance</h4>\n<b>Query string parameters :</b>\n\
<table>\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Required</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>ID</td>\n <td>Required</td>\n <td>string</td>\n\
\ <td>Sub-Account holder client ID</td>\n </tr>\n </tbody>\n</table>\n\
\n<b>Response body parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\n <th>Description</th>"
/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: "<h4>Add/Remove inbox tests from Sub-Account</h4>\n<b>Request Body\
\ parameters:</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Required</th>\n <th>Type</th>\n <th>Description</th>\n\
\ </tr>\n </thead>\n <tbody>\n <tr>\n <td>ID</td>\n <td>Required</td>\n\
\ <td>string</td>\n <td>Sub-Account holder Client ID</td>\n </tr>\n\
\ <tr>\n <td>Tests</td>\n <td>Required</td>\n <td>int</td>\n\
\ <td> </td>\n </tr>\n </tbody>\n</table>\n\n<b>Response "
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: "<h4>Get Sub-Accounts plan list</h4>\n<b>Request Body parameters:</b>\n\
<table>\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Required</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>ID</td>\n <td>Required</td>\n <td>string</td>\n\
\ <td>Sub-Account holder client ID</td>\n </tr>\n </tbody>\n</table>\n\
\n<b>Response body parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\n <th>Description</t"
/Client/Setting:
get:
tags:
- Security
summary: /Client/Setting | Get Client Account Settings
operationId: get__client_setting
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "<h4>Get Client Account Settings</h4>\n<b>Query String Parameters\
\ :</b> None <br>\n\n<b>Request Body Parameters:</b> None <br>\n\n<b>Response\
\ Body Parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>Company</td>\n <td><a href=\"http://www.benchmarkemail.com/models.htm#ClientSettingCompanyData\"\
\ >SettingCompanyData</a></td>\n <td>Array of error</td>\n </tr>\n\
\ <tr>\n <td>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: "<h4>Update Client Accounts Setting</h4>\n<b>Query String Parameters\
\ :</b> None <br>\n\n<b>Request Body Parameters:</b> \n<table>\n <thead>\n\
\ <tr>\n <th>Parameter</th>\n <th>Type</th>\n <th>Description</th>\n\
\ </tr>\n </thead>\n <tbody>\n <tr>\n <td>Company</td>\n \
\ <td><a href=\"http://www.benchmarkemail.com/models.htm#ClientSettingCompanyData\"\
\ >SettingCompanyData</a></td>\n <td>Setting Company Data</td>\n </tr>\n\
\ <tr>\n <td>Language</td>\n <td>string</td>\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: "<h4>Change Security PIN</h4>\n<b>Body Parameters (to be encoded\
\ as a JSON string)</b>\n<table>\n<thead>\n<tr>\n<th>Key</th>\n<th>Required</th>\n\
<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>ResetPIN</td>\n\
<td>Required</td>\n<td>New PIN</td>\n</tr>\n<tr>\n<td>ResetConfirmPIN</td>\n\
<td>Required</td>\n<td>Confirm New PIN</td>\n</tr>\n<tr>\n<td>ResetOldPIN</td>\n\
<td>Required</td>\n<td>Current PIN</td>\n</tr>\n</tbody>\n</table>\n<b>Response\
\ Body Parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\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: "<h4>Save Security PIN</h4>\n<b>Body Parameters (to be encoded\
\ as a JSON string)</b>\n<table>\n<thead>\n<tr>\n<th>Key</th>\n<th>Required</th>\n\
<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>NewPIN</td>\n<td>Required</td>\n\
<td>New PIN</td>\n</tr>\n<tr>\n<td>ConfirmNewPIN</td>\n<td>Required</td>\n\
<td>Confirm New PIN</td>\n</tr>\n</tbody>\n</table>\n<b>Response Body Parameters\
\ :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Type</th>\n\
\ <th>Description</th>\n </tr>\n </thead>\n <tbody>\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: "<h4>Disable Security PIN</h4>\n<b>Body Parameters (to be encoded\
\ as a JSON string)</b>\n<table>\n<thead>\n<tr>\n<th>Key</th>\n<th>Required</th>\n\
<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>DisableOldPIN</td>\n\
<td>Required</td>\n<td>Old PIN</td>\n</tr>\n</tbody>\n</table>\n<b>Response\
\ Body Parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>retVal</td>\n <td>string</td>\n \
\ <td>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: "<h4>Send PIN via email incase you forgot</h4>\n<b>Response Body\
\ Parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>retVal</td>\n <td>string</td>\n \
\ <td>return Value</td>\n </tr>\n <tr>\n <td>Error</td>\n \
\ <td><a href=\"http://www.benchmarkemail.com/models.htm#ErrorData\" >ErrorData</a></td>\n\
\ <td>Array of error</td>\n </tr>\n <tr>\n <td>Status</td>\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: "<h4>Link Account</h4>\n<b>Query string parameters :</b> None <br>\n\
\n<b>Request Body parameters:</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Required</th>\n <th>Type</th>\n <th>Description</th>\n\
\ </tr>\n </thead>\n <tbody>\n <tr>\n <td>Login</td>\n <td>Required</td>\n\
\ <td>string</td>\n <td>Login ID</td>\n </tr>\n <tr>\n \
\ <td>Password</td>\n <td>Required</td>\n <td>string</td>\n \
\ <td>From Email Address</td>\n </tr>\n <tr>\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: "<h4>Get list of link accounts</h4>\n<b>Query string parameters\
\ :</b> None <br>\n\n<b>Request Body parameters:</b> None <br>\n\n<b>Response\
\ body parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>Count</td>\n <td>string</td>\n <td>Number\
\ of link accounts </td>\n </tr>\n <tr>\n <td>Data</td>\n \
\ <td><a href=\"http://www.benchmarkemail.com/models.htm#ClientLinkAccountDetail"
/Client/LinkAccount/{ID}:
delete:
tags:
- Agency Account
summary: Delete Link Account
operationId: delete__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: "<h4>Delete Link Account</h4>\n<b>Query string parameters :</b>\
\ None\n\n<b>Request Body parameters:</b>\n<table>\n <thead>\n <tr>\n\
\ <th>Parameter</th>\n <th>Required</th>\n <th>Type</th>\n\
\ <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n\
\ <td>ID</td>\n <td>Required</td>\n <td>string</td>\n \
\ <td>Link Account ID</td>\n </tr>\n </tbody>\n</table>\n\n<b>Response\
\ body parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\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: "<h4>Update Link Account</h4>\n<b>Query string parameters :</b>\
\ None <br>\n\n<b>Request Body parameters:</b>\n<table>\n <thead>\n <tr>\n\
\ <th>Parameter</th>\n <th>Required</th>\n <th>Type</th>\n\
\ <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n\
\ <td>ID</td>\n <td>Required</td>\n <td>string</td>\n \
\ <td>Link Account ID</td>\n </tr>\n <tr>\n <td>Login</td>\n \
\ <td>Required</td>\n <td>string</td>\n <td>Login ID</td>\n \
\ </tr>\n <tr>\n <t"
get:
tags:
- Agency Account
summary: Get Link Account Details
operationId: get__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: "<h4>Get Link Account Details</h4>\n<b>Query string parameters\
\ :</b> None\n\n<b>Request Body parameters:</b>\n<table>\n <thead>\n <tr>\n\
\ <th>Parameter</th>\n <th>Required</th>\n <th>Type</th>\n\
\ <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n\
\ <td>ID</td>\n <td>Required</td>\n <td>string</td>\n \
\ <td>Link Account ID</td>\n </tr>\n </tbody>\n</table>\n\n<b>Response\
\ body parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\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: "<h4>Change Password</h4>\n<b>Body Parameters (to be encoded as\
\ a JSON string)</b>\n<table>\n<thead>\n<tr>\n<th>Key</th>\n<th>Required</th>\n\
<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>NewPassword</td>\n\
<td>Required</td>\n<td>New Password</td>\n</tr>\n<tr>\n<td>ConfirmPassword</td>\n\
<td>Required</td>\n<td>Confirm Password</td>\n</tr>\n</tbody>\n</table>\n\
<b>Response Body Parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>"
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: "<h4>Send Reset Email to change primary email</h4>\n<b>Response\
\ Body Parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>retVal</td>\n <td>string</td>\n \
\ <td>return Value</td>\n </tr>\n <tr>\n <td>Error</td>\n \
\ <td><a href=\"http://www.benchmarkemail.com/models.htm#ErrorData\" >ErrorData</a></td>\n\
\ <td>Array of error</td>\n </tr>\n <tr>\n <td>Status</td>\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: "<h4>Get All Confirmed Email</h4>\n<b>Query string parameters :</b>\
\ None <br>\n\n<b>Request Body parameters:</b> None <br>\n\n<b>Response body\
\ parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>Count</td>\n <td>string</td>\n <td>Total\
\ Confirmed Emails</td>\n </tr>\n <tr>\n <td>Data</td>\n <td><a\
\ href=\"http://www.benchmarkemail.com/models.htm#ClientConfirmEmailAllData\"\
\ "
/Client/ConfirmedEmail/Email:
post:
tags:
- Account Settings
summary: Send Confirm Email Verification Email
operationId: post__client_confirmedemail_email
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "<h4>Send Confirm Email Verification Email</h4>\n<b>Query string\
\ parameters :</b> None <br>\n\n<b>Request Body parameters:</b> \n<table>\n\
\ <thead>\n <tr>\n <th>Parameter</th>\n <th>Required</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>EmailIDs</td>\n <td>Required</td>\n \
\ <td>string</td>\n <td>Email Address</td>\n </tr>\n </tbody>\n\
</table>\n<b>Response body parameters :</b>\n<table>\n <thead>\n <tr>\n\
\ <th>Parameter</th"
requestBody:
content:
application/json:
schema:
type: object
/Client/ConfirmedEmail:
get:
tags:
- Account Settings
summary: Get List of Confirmed Emails
operationId: get__client_confirmedemail
parameters: []
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: "<h4>Get List of Confirmed Emails</h4>\n<b>Query String Parameters\
\ :</b> None <br>\n\n<b>Request Body Parameters:</b> None <br>\n\n<b>Response\
\ Body Parameters :</b>\n<table>\n <thead>\n <tr>\n <th>Parameter</th>\n\
\ <th>Type</th>\n <th>Description</th>\n </tr>\n </thead>\n\
\ <tbody>\n <tr>\n <td>Emails</td>\n <td>string</td>\n \
\ <td>List of Emails</td>\n </tr>\n <tr>\n <td>Error</td>\n \
\ <td><a href=\"http://www.benchmarkemail.com/models.htm#ErrorData\" >ErrorData</a></t"
/Client/Email/Reset:
get:
tags:
- Account Settings
summary: Get Current email at the time of Reset Email
operationId: get__client_email_reset
parameters:
- name: GUID
in: query
required: false
schema:
type: string
responses:
'200':
description: Successful response
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
description: '<h4>Get Current email at the time of Reset Email </h4>
<b>Query String Parameter : </b>
<table>
<thead>
<tr>
<th>Key</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>GUID</td>
<td>optional</td>
<td>Unique ID</td>
</tr>
</tbody>
</table>
<b>Response body parameters</b>
<table>
<thead>
<tr>
<th>Key</th><th>Type</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td>Email</td><td>String</td><td>Email Address</td></tr>
<tr><td>Status</td><td>String</td><td>1 if su
# --- truncated at 32 KB (340 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/openapi/benchmark-email-benchmark-email-api-openapi.yml