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 API

The current Benchmark Email REST API on the benchmarkemail.io platform. Manages contacts, contact structures and custom fields, lists, email campaigns, email templates, sending domains and performance reports. Authenticated with a scoped X-API-Key and served from a per-account regional base URL. Campaign scheduling and sending, and sending-domain verification, are deliberately web-only.

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

Tagged areas include Contacts, List, Email Campaigns, Email Templates, and Sending Domains. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 40 operations across 27 paths, organized into 7 resource areas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, {apiBaseUrl}.

40 operations 27 paths 0 schemas 4 DELETE22 GET3 PATCH9 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api-{region}-{cluster}.benchmarkemail.io
Authentication
API Key
Resource Areas
7

Authentication & Security 1

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

  • apiKeyAuth — API key authentication

Paths & Operations 40

Across 27 paths, the API surfaces 40 operations — 4 DELETE, 22 GET, 3 PATCH, 9 POST, 2 PUT. They span 7 resource areas: contact, contact-structure, lists, email-campaign, email-domain, email-template, reports. Each is listed below with its method, path, parameters, and response codes.

contact 10

Contact related endpoints

GET
/api/contact
Get all contacts
get_api_contact → 200
POST
/api/contact
Create a new contact
post_api_contact body → 200
GET
/api/contact/events
Get account contact events
get_api_contact_events 4 params → 200400401
POST
/api/contact/export
Export contacts
post_api_contact_export body → 200400401
POST
/api/contact/search
Search for contacts
post_api_contact_search body → 200400401
DELETE
/api/contact/{contactId}
Delete a contact by id
delete_api_contact_by_contactId 1 param → 200404
GET
/api/contact/{contactId}
Get a contact by id
get_api_contact_by_contactId 1 param → 200404
PATCH
/api/contact/{contactId}
Partial update a contact by id
patch_api_contact_by_contactId 1 param body → 200404
PUT
/api/contact/{contactId}
Update a contact by id
put_api_contact_by_contactId 1 param body → 200404
GET
/api/contact/{contactId}/events
Get contact events
get_api_contact_by_contactId_events 4 params → 200400401
contact-structure 4

Contact structure related endpoints

GET
/api/contact-structure
Get all contact structures
get_api_contact_structure → 200
POST
/api/contact-structure
Create a new contact structure
post_api_contact_structure body → 200
GET
/api/contact-structure/{contactStructureId}
Get a contact structure by id
get_api_contact_structure_by_contactStructureId 1 param → 200
PUT
/api/contact-structure/{contactStructureId}
Update a contact structure by id
put_api_contact_structure_by_contactStructureId 1 param body → 200400
lists 9

List related endpoints

DELETE
/api/contact-structure/{contactStructureId}/lists
Delete multiple lists
delete_api_contact_structure_by_contactStructureId_lists 1 param body → 204400
GET
/api/contact-structure/{contactStructureId}/lists
Get paginated lists
get_api_contact_structure_by_contactStructureId_lists 5 params → 200
POST
/api/contact-structure/{contactStructureId}/lists
Create a new list
post_api_contact_structure_by_contactStructureId_lists 1 param body → 201400
GET
/api/contact-structure/{contactStructureId}/lists/all
Get all lists
get_api_contact_structure_by_contactStructureId_lists_all 1 param → 200
POST
/api/contact-structure/{contactStructureId}/lists/merge
Merge lists into a new list.
post_api_contact_structure_by_contactStructureId_lists_merge 1 param body → 200400
DELETE
/api/contact-structure/{contactStructureId}/lists/{listId}
Delete a list by id
delete_api_contact_structure_by_contactStructureId_lists_by_listId 2 params → 204400
GET
/api/contact-structure/{contactStructureId}/lists/{listId}
Get a list by id
get_api_contact_structure_by_contactStructureId_lists_by_listId 2 params → 200400
PATCH
/api/contact-structure/{contactStructureId}/lists/{listId}
Update a list by id
patch_api_contact_structure_by_contactStructureId_lists_by_listId 2 params body → 200400
POST
/api/contact-structure/{contactStructureId}/lists/{listId}/duplicate
Duplicate a list
post_api_contact_structure_by_contactStructureId_lists_by_listId_duplicate 2 params body → 201400401404
email-campaign 6

Email campaign related endpoints

GET
/api/email/campaign
Get all campaigns
get_api_email_campaign 5 params → 200400401
POST
/api/email/campaign
Add a campaign
post_api_email_campaign body → 200400401
DELETE
/api/email/campaign/{campaignId}
Delete campaign by id
delete_api_email_campaign_by_campaignId 1 param → 204400401404
GET
/api/email/campaign/{campaignId}
Get campaign by id
get_api_email_campaign_by_campaignId 1 param → 200401404
PATCH
/api/email/campaign/{campaignId}
Update campaign by id
patch_api_email_campaign_by_campaignId 1 param body → 200400401404
POST
/api/email/campaign/{campaignId}/duplicate
Duplicate an existing campaign
post_api_email_campaign_by_campaignId_duplicate 1 param body → 200400401404
email-domain 3

Email domain related endpoints

GET
/api/email/domain
Get all domains
get_api_email_domain → 200401
GET
/api/email/domain/grey-label
Get the grey label domain for the account
get_api_email_domain_grey_label → 200404
GET
/api/email/domain/{domainId}
Get a domain by id
get_api_email_domain_by_domainId 1 param → 200401404
email-template 3

Email template related endpoints

GET
/api/email/template
Get email templates
get_api_email_template 4 params → 200400401500
GET
/api/email/template/categories
Get email template categories
getEmailTemplateCategories 1 param → 200400401500
GET
/api/email/template/{id}
Get email template by ID
get_api_email_template_by_id 2 params → 200401500
reports 5

Report related endpoints

GET
/api/reports/dashboard
Get dashboard snapshot reports
get_api_reports_dashboard 2 params → 200
GET
/api/reports/email/overall
Get overall email reports
get_api_reports_email_overall 2 params → 200
GET
/api/reports/email/overall/histogram
Get overall email histogram by event type
get_api_reports_email_overall_histogram 3 params → 200
GET
/api/reports/email/{id}
Get individual email campaign reports
get_api_reports_email_by_id 1 param → 200
GET
/api/reports/email/{id}/engagement
Get individual email campaign engagement reports
get_api_reports_email_by_id_engagement 3 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchmark-email-api-openapi.json 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 General API
Where this information came from

This is an independent, third-party profile of Benchmark Email 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.