How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Benchmark Email General API

General operations

Benchmark Email General API is one of 30 APIs that Benchmark Email publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 56 operations across 52 paths. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against a single base URL, https://clientapi.benchmarkemail.com.

56 operations 52 paths 0 schemas 16 DELETE16 GET6 PATCH18 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://clientapi.benchmarkemail.com
Authentication
API Key
License
Proprietary
Resource Areas
1

Authentication & Security 1

Benchmark Email General API declares 1 security scheme for authenticating requests. An API key is passed in the header as AuthToken (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API token obtained from https://ui.benchmarkemail.com/IntegrateAPI

Paths & Operations 56

Across 52 paths, the API surfaces 56 operations — 16 DELETE, 16 GET, 6 PATCH, 18 POST. Each is listed below with its method, path, parameters, and response codes.

General 56

General operations

GET
/Client/Notification
Get Notification
get__client_notification → 200400401404
GET
/Client/Responsive
Check if Responsive
get__client_responsive → 200400401404
PATCH
/Client/Responsive
Set Responsive
patch__client_responsive body → 200400401404
GET
/Client/RatingRange
Get Clients Rating Range
get__client_ratingrange → 200400401404
GET
/Client/Archive/Domain
Get Archive Domain Name
get__client_archive_domain → 200400401404
GET
/Client/Community/Domain
Get Community Domain
get__client_community_domain → 200400401404
GET
/Client/DMarc
Get DMARC List
get__client_dmarc → 200400401404
GET
/Client/ListUploadTerms
Get List Upload Terms
get__client_listuploadterms → 200400401404
PATCH
/Contact/{ListID}
Modify Contact List
patch__contact__listid 1 param → 200400401404
DELETE
/Contact/ContactDetails
Delete the selected contacts from current lists
delete__contact_contactdetails 2 params → 200400401404
POST
/Contact/{ID}/Download
Download report
post__contact__id__download 1 param → 200400401404
GET
/Contact/{ListIDs}/Compare
Compare contacts
get__contact__listids__compare 1 param → 200400401404
POST
/Contact/{CleanListID}/Clean
Clean List
post__contact__cleanlistid__clean 1 param body → 200400401404
DELETE
/Contact/{ListID}/Trash
Delete Trash List
delete__contact__listid__trash 1 param → 200400401404
DELETE
/Contact/{listID}/ContactDetails/{ContactID}
Delete the selected contacts from current list from contact details page
delete__contact__listid__contactdetails__contactid 2 params → 200400401404
DELETE
/Contact/{ListID}/ContactDetails/All/{ContactID}
Delete the selected contacts from ALL lists from Contact Details page
delete__contact__listid__contactdetails_all__contactid 2 params → 200400401404
DELETE
/Contact/ContactDetails/{ContactID}
DELETE Contact only from search contact page
delete__contact_contactdetails__contactid 1 param → 200400401404
DELETE
/Contact/{ListID}/MoveToDNC/{ContactID}
Move Contacts to Do Not Contact (i.e Master Unsubscribe list)
delete__contact__listid__movetodnc__contactid 2 params → 200400401404
POST
/Contact/{ListID}/MoveContacts/{TargetListID}/{ContactIDs}
Move Contacts
post__contact__listid__movecontacts__targetlistid___contactids 3 params → 200400401404
POST
/Contact/{ListID}/MoveContacts
Move Bulk Contacts
post__contact__listid__movecontacts 1 param body → 200400401404
POST
/Contact/CopyContacts/{ListID}/{ContactID}
Copy Contacts
post__contact_copycontacts__listid___contactid 2 params → 200400401404
POST
/Contact/CopyContacts
Copy Bulk Contacts
post__contact_copycontacts → 200400401404
POST
/Contact/{ListID}/ShareLists/{ClientIDs}
Share Lists with SubAccounts
post__contact__listid__sharelists__clientids 2 params → 200400401404
POST
/Contact/{ListID}/ResendEmails
Resend Email
post__contact__listid__resendemails 1 param → 200400401404
GET
/Contact/{ListIDs}/MergeLists
Get contact Merge List
get__contact__listids__mergelists 1 param → 200400401404
POST
/Contact/{ListIDs}/MergeIntoExistingList
Merge contacts into Existing List
post__contact__listids__mergeintoexistinglist 1 param body → 200400401404
POST
/Contact/{ListIDs}/MergeIntoListNewList
Merge contacts into new list
post__contact__listids__mergeintolistnewlist 1 param → 200400401404
POST
/Contact/{ListID}/SplitIntoListNewList
Split contacts into new list
post__contact__listid__splitintolistnewlist 1 param → 200400401404
DELETE
/Contact/DeleteList/{ListIDss}
Delete List
delete__contact_deletelist__listidss 1 param → 200400401404
DELETE
/Contact/DeleteTrashList/{ListIDs}
Delete Trash List
delete__contact_deletetrashlist__listids 1 param → 200400401404
PATCH
/Contact/RestoreTrashList/{ListIDs}
Restore Trash List
patch__contact_restoretrashlist__listids 1 param → 200400401404
DELETE
/Emails/{ID}
Delete the email
delete__emails__id 1 param → 200400401404
POST
/Emails/{ID}
Copy an existing email
post__emails__id 1 param → 200400401404
DELETE
/Emails/{ID}/Trash
Permenantly delete an email from Trash
delete__emails__id__trash 1 param → 200400401404
POST
/Emails/{ID}/Trash
Restore an email from Trash
post__emails__id__trash 1 param → 200400401404
GET
/Emails/{ID}/Preview
Get the Preview for the email
get__emails__id__preview 1 param → 200400401404
PATCH
/Emails/Community/{ID}
Add Email to Community
patch__emails_community__id 1 param → 200400401404
GET
/Emails/CommunityGetEmail/{ID}
GET Community Email By ID
get__emails_communitygetemail__id 1 param → 200400401404
POST
/Emails/{ID}/ShareTemplate
Share Template to sub accounts
post__emails__id__sharetemplate 1 param → 200400401404
DELETE
/Emails/{ID}/ABSplit
Delete ABSplit Campaign
delete__emails__id__absplit 1 param → 200400401404
GET
/Automation
Get list of automation
get__automation 5 params → 200400401404
DELETE
/Automation/{AutomationID}
Delete an Automation
delete__automation__automationid 1 param → 200400401404
POST
/Automation/{AutomationID}/Emails/{AutomationDetailID}
Copy email in an Automation
post__automation__automationid__emails__automationdetailid 2 params → 200400401404
DELETE
/Automation/{AutomationID}/Emails/{AutomationDetailID}
Delete an Automation Email
delete__automation__automationid__emails__automationdetailid 2 params → 200400401404
POST
/Automation/{AutomationID}/Copy
Create copy of exiting Automation
post__automation__automationid__copy 1 param body → 200400401404
GET
/ABSplit/
Get a list of AB Tests
get__absplit 6 params → 200400401404
DELETE
/ABSplit/{ID}
Delete the AB Test email
delete__absplit__id 1 param → 200400401404
PATCH
/ABSplit/{ID}/Status
Update the AB Test Status
patch__absplit__id__status 1 param body → 200400401404
GET
/Survey
Get a list of survey
get__survey 5 params → 200400401404
POST
/Survey/{ID}/Copy
Copy a Survey
post__survey__id__copy 1 param body → 200400401404
DELETE
/Survey/{ID}
Delete a Survey
delete__survey__id 1 param → 200400401404
PATCH
/Survey/{ID}/StatusUpdate/{Status}
Update status of the survey
patch__survey__id__statusupdate__status 2 params → 200400401404
GET
/Poll/
Get list of Polls.
get__poll 6 params → 200400401404
POST
/Poll/{PollID}/Copy
Copy a poll
post__poll__pollid__copy 1 param body → 200400401404
DELETE
/Poll/{PollID}
Delete a poll
delete__poll__pollid 1 param → 200400401404
GET
/Poll/{PollID}/Render
Get preview of a poll
get__poll__pollid__render 1 param → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchmark-email-general-api-openapi.yml Raw ↑

Other APIs Benchmark Email publishes across the network.

Benchmark Email ABTest Creation API
Benchmark Email Account Settings API
Benchmark Email Add Contacts API
Benchmark Email Agency Account API
Benchmark Email Archive API
Benchmark Email Automation Creation API
Benchmark Email Contact Configurations & Searches API
Benchmark Email Contact Reports & Metrics API
Benchmark Email Email Editor API
Benchmark Email Email Email Rss Creation API
Benchmark Email Engagement API
Benchmark Email Help API
Where this information came from

This is an independent, third-party profile of Benchmark Email General API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.