Benchmark Email

Benchmark Email Segments API

Manage contact segments

GitHub OpenAPI
Business capability
Customer Segmentation Management BC-420.20

Operations 11

POST /Contact/{ListID}/Segments Creating segment from contact IDs #
GET /Contact/Segments Getting a list of segments #
DELETE /Contact/Segments/{SegmentID} Delete Segment #
GET /Contact/Segments/{SegmentID} Get segment by ID #
PATCH /Contact/Segments/{SegmentID} Update Segment #
GET /Contact/Segments/{SegmentID}/SegmentDetails Get Segment Details #
GET /Contact/Segments/Name/{ListID} Get Segment Auto Generate Name #
DELETE /Contact/Segments/{SegmentID}/Criteria Delete the Segment Criteria #
POST /Contact/Segments/{SegmentID}/Criteria Create Criteria #
GET /Contact/{ListID}/SegmentLists Get Segment List #
GET /Contact/{ID}/Segment/Download Get download segment data #

Documentation

📖
Documentation
https://developer.benchmarkemail.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/openapi/benchmark-email-segments-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/BenchmarkEmail/RESTful-API-v3

Other Resources

🔗
PostmanCollection
https://github.com/BenchmarkEmail/RESTful-API-v3/tree/master/Postman%20Collections

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/benchmark-email-segments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

benchmark-email-segments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Benchmark Email RESTful API v3.0 Segments API
  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: []
tags:
- name: Segments
  description: Manage contact segments
paths:
  /Contact/{ListID}/Segments:
    post:
      tags:
      - Segments
      summary: Creating segment from contact IDs
      operationId: post__contact__listid__segments
      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: 'Creates segment from contact IDs


        URL Parameters


        KeyRequiredDescription


        {{ListID}}requiredID of the list


        Body Parameters (to be encoded as a JSON string)


        KeyRequiredDescription


        ContactIDsrequiredIDs of the contacts to be inserted'
      requestBody:
        content:
          application/json:
            schema:
              type: object
  /Contact/Segments:
    get:
      tags:
      - Segments
      summary: Getting a list of segments
      operationId: get__contact_segments
      parameters: []
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
      description: 'Get Segments


        Query String parameters


        KeyRequiredTypeDescription


        PageNumberoptionalint Page Number


        PageSizerequiredint Number of rows on the page


        Filterrequiredstring Filter value


        OrderByrequiredstring Order By Column ('
  /Contact/Segments/{SegmentID}:
    delete:
      tags:
      - Segments
      summary: Delete Segment
      operationId: delete__contact_segments__segmentid
      parameters:
      - name: SegmentID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
      description: 'Deletes an existing segment


        URL Parameters


        KeyRequiredTypeDescription


        required{{SegmentID}}stringID of the segment


        Response body parameters


        KeyTypeDescription


        statusstring1 if successful, -1 if error'
    get:
      tags:
      - Segments
      summary: Get segment by ID
      operationId: get__contact_segments__segmentid
      parameters:
      - name: SegmentID
        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 an existing segment by ID


        URL Parameters


        KeyRequiredTypeDescription


        {{SegmentID}}requiredstringID of the segment


        Response body parameters


        KeyTypeDescription


        Statusstring1 if successful, -1 if error


        <t'
    patch:
      tags:
      - Segments
      summary: Update Segment
      operationId: patch__contact_segments__segmentid
      parameters:
      - name: SegmentID
        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 Segment


        URL Parameters


        KeyRequiredTypeDescription


        {{SegmentID}}requiredstringID of the segment


        Body Parameters (To be passed as a JSON string)


        KeyRequiredTypeDescription


        Dataoptional<a href="http://w'
      requestBody:
        content:
          application/json:
            schema:
              type: object
  /Contact/Segments/{SegmentID}/SegmentDetails:
    get:
      tags:
      - Segments
      summary: Get Segment Details
      operationId: get__contact_segments__segmentid__segmentdetails
      parameters:
      - name: SegmentID
        in: path
        required: true
        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: SearchFilter
        in: query
        required: false
        schema:
          type: string
      - name: SearchType
        in: query
        required: false
        schema:
          type: string
      - name: SearchField
        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 Segment Details


        URL Parameters


        KeyRequiredTypeDescription


        {{SegmentID}}requiredstringID of the segment


        Query String Parameters


        KeyRequiredTypeDescription


        PageNumberoptionalintPage Number


        PageSiz'
  /Contact/Segments/Name/{ListID}:
    get:
      tags:
      - Segments
      summary: Get Segment Auto Generate Name
      operationId: get__contact_segments_name__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 Segment Auto Generate Name


        URL Parameters


        KeyRequiredTypeDescription


        {{ListID}}requiredstringID of the list


        Response body parameters


        KeyTypeDescription


        Statusstring1 if successful, -1 if error


        <td'
  /Contact/Segments/{SegmentID}/Criteria:
    delete:
      tags:
      - Segments
      summary: Delete the Segment Criteria
      operationId: delete__contact_segments__segmentid__criteria
      parameters:
      - name: SegmentID
        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 Segment


        URL Parameters


        KeyRequiredTypeDescription


        {{SegmentID}}requiredstringID of the segment


        Response body parameters


        KeyTypeDescription


        Statusstring1 if successful, -1 if error


        ErrorData'
    post:
      tags:
      - Segments
      summary: Create Criteria
      operationId: post__contact_segments__segmentid__criteria
      parameters:
      - name: SegmentID
        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 a new Segments Criteria


        URL Parameters


        KeyRequiredTypeDescription


        {{SegmentID}}requiredstringID of the segment


        Body Parameters (To be passed as a JSON string)


        KeyRequiredTypeDescription


        Criteriarequired<'
      requestBody:
        content:
          application/json:
            schema:
              type: object
  /Contact/{ListID}/SegmentLists:
    get:
      tags:
      - Segments
      summary: Get Segment List
      operationId: get__contact__listid__segmentlists
      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 Segment List


        URL Parameters


        KeyRequiredTypeDescription


        {{ListID}}requiredstringID of the list


        Response body parameters


        KeyTypeDescription


        Statusstring1 if successful, -1 if error


        Count<td'
  /Contact/{ID}/Segment/Download:
    get:
      tags:
      - Segments
      summary: Get download segment data
      operationId: get__contact__id__segment_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 download segment data


        URL Parameters


        KeyRequiredTypeDescription


        {{ID}}requiredstringIDs of the segment


        Response body parameters


        KeyTypeDescription


        Statusstring1 if successful, -1 error


        Segment'
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: AuthToken
      description: API token obtained from https://ui.benchmarkemail.com/Integrate#API