Optimizely Mail ID API

Get information about a mail ID

Operations 3

GET /{clientId}/mailid/{mailId} Get information about a mail ID #
GET /{clientId}/mailid/{mailId}/plain Get information about a plain mail ID (contains only mailing id) #
GET /{clientId}/mailid Retrieve a mail ID #

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/optimizely-mail-id-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.

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

OpenAPI Specification

optimizely-mail-id-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Optimizely Campaign REST Mail ID API
  description: This documentation lists all available resources and endpoints of the Optimizely Campaign REST API.
  version: '1'
servers:
- url: https://api.campaign.episerver.net/rest
tags:
- name: Mail ID
  description: Get information about a mail ID
paths:
  /{clientId}/mailid/{mailId}:
    get:
      tags:
      - Mail ID
      summary: Get information about a mail ID
      description: Get detailed information about a mail ID. A mail ID is the aggregation of the mailing ID, recipient list ID and recipient ID.
      operationId: getDetailedMailIdInformationByEncodedId
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: mailId
        in: path
        description: Mail ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The mail ID information was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestMailIdInfo'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestMailIdInfo'
        '400':
          description: The mail ID is invalidly encoded.
        '409':
          description: The indicated mail ID is not assigned to the indicated client. Ensure that "clientId" and "mailId" are correct and that "mailId" is assigned to the indicated client.
      security:
      - Authorization: []
  /{clientId}/mailid/{mailId}/plain:
    get:
      tags:
      - Mail ID
      summary: Get information about a plain mail ID (contains only mailing id)
      description: Get detailed information about a plain mail ID. A plain mail ID consists only of the mailing ID.
      operationId: getDetailedMailIdInformationByEncodedPlainId
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: mailId
        in: path
        description: Mail ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The mail ID information was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestMailIdPlainInfo'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestMailIdPlainInfo'
        '400':
          description: The mail ID is invalidly encoded or the indicated mail ID is not assigned to the indicated client. Ensure that "clientId" and "mailId" are correct and that "mailId" is assigned to the indicated client.
      security:
      - Authorization: []
  /{clientId}/mailid:
    get:
      tags:
      - Mail ID
      summary: Retrieve a mail ID
      description: Retrieve a mail ID (for further usage). A mail ID is the aggregation of the mailing ID, recipient list ID and recipient ID.
      operationId: retrieveBmMailId
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: MailingToUserID
        in: query
        description: MailingToUserID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The mail ID information was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestMailId'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestMailId'
        '400':
          description: A valid mailingToUserId must be provided.
        '409':
          description: The indicated mailingToUser ID is not assigned to the indicated client. Ensure that "clientId" and "mailingToUserId" are correct and that "mailingToUserId" is assigned to the indicated client.
      security:
      - Authorization: []
components:
  schemas:
    RestMailIdPlainInfo:
      type: object
      properties:
        mailingId:
          type: integer
          description: Mailing ID
          format: int64
        links:
          type: array
          description: Restful links
          items:
            type: object
            properties:
              uriBuilder:
                type: object
              rels:
                type: array
                items:
                  type: string
              rel:
                type: string
              type:
                type: string
              params:
                type: object
                additionalProperties:
                  type: string
              title:
                type: string
              uri:
                type: string
                format: uri
            description: Restful links
    RestMailIdInfo:
      type: object
      properties:
        mailingId:
          type: integer
          description: Mailing ID
          format: int64
        recipientListId:
          type: integer
          description: Recipient list ID
          format: int64
        recipientId:
          type: string
          description: Recipient ID
        links:
          type: array
          description: Restful links
          items:
            type: object
            properties:
              uriBuilder:
                type: object
              rels:
                type: array
                items:
                  type: string
              rel:
                type: string
              type:
                type: string
              params:
                type: object
                additionalProperties:
                  type: string
              title:
                type: string
              uri:
                type: string
                format: uri
            description: Restful links
    RestMailId:
      type: object
      properties:
        mailId:
          type: string
          description: Encoded mail ID
  securitySchemes:
    Authorization:
      type: apiKey
      name: Authorization
      in: header
x-readme:
  explorer-enabled: true
  proxy-enabled: true