Optimizely

Optimizely Mail archive API

Get archived mailings

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /{clientId}/mailarchive/{bmMailId} Get details of one archived mailing · Get information about an archived mailing #
Ask an LLM
“How do I see metadata for a single archived email sent to a recipient?”
“When was a specific archived mailing created and what type was it?”
Tell an agent
Get archive details for mail {bmMailId} in client {clientId}.
Show the mailing type and creation time of archived mail {bmMailId} for client {clientId}.
GET /{clientId}/mailarchive Search archived mailings · Get information about all archived mailings #
Ask an LLM
“Which emails were archived for a given recipient address?”
“Can I filter archived mailings by date range and mailing type?”
Tell an agent
List archived mails for client {clientId} sent to {recipientAddress}.
Find archived mails for client {clientId} created between {from} and {until}.
GET /{clientId}/mailarchive/{bmMailId}/content Download an archived mailing's content · Get the content of an archived mailing #
Ask an LLM
“How do I retrieve the actual content of an archived email?”
“Can I download an archived mailing as EML or HTML, compressed?”
Tell an agent
Download the content of archived mail {bmMailId} for client {clientId}.
Get archived mail {bmMailId} for client {clientId} as {mailFormat}.
GET /{clientId}/mailarchive/content Bulk download archived mailing contents · Get compressed file with archived mailing contents #
Ask an LLM
“How do I export the contents of many archived emails at once?”
“Can I get a compressed bundle of archived mails for one recipient?”
Tell an agent
Download a compressed file of archived mail contents for client {clientId} from {from} to {until}.
Export the archived mail contents sent to {recipientAddress} for client {clientId} as a zip.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-mail-archive-api-openapi.yml

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:optimizely-mail-archive-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

optimizely-mail-archive-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Optimizely Campaign REST Mail archive 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 archive
  description: Get archived mailings
paths:
  /{clientId}/mailarchive/{bmMailId}:
    get:
      tags:
      - Mail archive
      summary: Get information about an archived mailing
      description: Get detailed information about an archived mailing, such as mailing type, mailingToUser ID and the date and time of creation.
      operationId: getArchivedMailMetaData
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: bmMailId
        in: path
        description: Encoded mail ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The information about the archived mailing was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestArchiveMail'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestArchiveMail'
        '400':
          description: The bmMailId is invalidly encoded.
        '404':
          description: The bmMailId could not be found in the mail archive.
        '409':
          description: The indicated bmMailId is not assigned to the indicated client. Ensure that "clientId" and "bmMailId" are correct and that "bmMailId" is assigned to the indicated client.
      security:
      - Authorization: []
  /{clientId}/mailarchive:
    get:
      tags:
      - Mail archive
      summary: Get information about all archived mailings
      description: Get detailed information about all archived mailings, such as mailing type, mailingToUser ID and the date and time of creation.
      operationId: selectArchiveMails
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: from
        in: query
        description: Time filter to select archived mails created from date. DateTimeFormat 2021-11-07 17:43:01. UTC Timezone will be used to parse the parameter
        schema:
          type: string
      - name: bmMailIds
        in: query
        description: Collection of encoded mail IDs
        schema:
          type: array
          items:
            type: string
      - name: optinStatus
        in: query
        description: Double Opt-in status (Only for confirmation archived mails)
        schema:
          type: string
          enum:
          - non_confirmed
          - confirmed
      - name: mailingId
        in: query
        description: Mailing ID of archived mail
        schema:
          type: integer
          format: int64
      - name: recipientId
        in: query
        description: Recipient ID (usually the email address)
        schema:
          type: string
      - name: mailingTypes
        in: query
        description: Collection of mailingTypes. Supported mailingTypes [event, transaction, confirmation, campaign]
        schema:
          type: string
      - name: recipientAddress
        in: query
        description: Recipient address (usually the email address)
        schema:
          type: string
      - name: until
        in: query
        description: Time filter to select archived mails created until date. DateTimeFormat 2021-11-07 17:43:01. UTC Timezone will be used to parse the parameter
        schema:
          type: string
      - name: next-cursor
        in: header
        description: Cursor to retrieve next batch. Cursor is going to expire after 10 minutes.
        schema:
          type: string
      responses:
        '200':
          description: The information about the archived mailing was retrieved successfully.
          headers:
            next-cursor:
              description: Cursor to retrieve next batch. Cursor is going to be expired after 10 minutes.
              style: simple
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestArchiveMail'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestArchiveMail'
        '204':
          description: Archived mailings could not be found.
        '400':
          description: Invalid request or 'next-cursor' is expired. Make sure you requested no more than 10000 results.
      security:
      - Authorization: []
  /{clientId}/mailarchive/{bmMailId}/content:
    get:
      tags:
      - Mail archive
      summary: Get the content of an archived mailing
      description: Get the content of an archived mailing. You can retrieve the content as EML or HTML file, and optionally compress the mailing to save space.
      operationId: getArchivedMailContent
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: mailFormat
        in: query
        description: 'File type of the retrieved mailing<p><i>Default value</i> : EML</p>'
        schema:
          type: string
          enum:
          - EML
          - HTML
      - name: compressed
        in: query
        description: 'Compress the mailing to save space<p><i>Default value</i> : false</p>'
        schema:
          type: boolean
      - name: bmMailId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The archived mailing was retrieved successfully.
          content:
            application/octet-stream:
              schema:
                type: object
            application/vnd.optivo.broadmail.v1+json:
              schema:
                type: object
        '400':
          description: The bmMailId is invalidly encoded.
        '404':
          description: The bmMailId could not be found in the mail archive.
        '409':
          description: The indicated bmMailId is not assigned to the indicated client. Ensure that "clientId" and "bmMailId" are correct and that "bmMailId" is assigned to the indicated client.
      security:
      - Authorization: []
  /{clientId}/mailarchive/content:
    get:
      tags:
      - Mail archive
      summary: Get compressed file with archived mailing contents
      description: Get compressed file with archived mailing contents.
      operationId: selectArchivedMailContents
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: from
        in: query
        description: Time filter to select archived mails created from date. DateTimeFormat 2021-11-07 17:43:01. UTC Timezone will be used to parse the parameter
        schema:
          type: string
      - name: bmMailIds
        in: query
        description: Collection of encoded mail IDs
        schema:
          type: array
          items:
            type: string
      - name: optinStatus
        in: query
        description: Double Opt-in status (Only for confirmation archived mails)
        schema:
          type: string
          enum:
          - non_confirmed
          - confirmed
      - name: mailingId
        in: query
        description: Mailing ID of archived mail
        schema:
          type: integer
          format: int64
      - name: recipientId
        in: query
        description: Recipient ID (usually the email address)
        schema:
          type: string
      - name: mailingTypes
        in: query
        description: Collection of mailingTypes. Supported mailingTypes [event, transaction, confirmation, campaign]
        schema:
          type: string
      - name: recipientAddress
        in: query
        description: Recipient address (usually the email address)
        schema:
          type: string
      - name: until
        in: query
        description: Time filter to select archived mails created until date. DateTimeFormat 2021-11-07 17:43:01. UTC Timezone will be used to parse the parameter
        schema:
          type: string
      - name: next-cursor
        in: header
        description: Cursor to retrieve next batch. Cursor is going to expire after 10 minutes.
        schema:
          type: string
      responses:
        '200':
          description: The compressed file with archived mailing contents was retrieved successfully.
          headers:
            next-cursor:
              description: Cursor to retrieve next batch. Cursor is going to be expired after 10 minutes.
              style: simple
              schema:
                type: integer
          content:
            application/octet-stream:
              schema:
                type: object
            application/vnd.optivo.broadmail.v1+json:
              schema:
                type: object
        '204':
          description: Archived mailings could not be found.
        '400':
          description: Invalid request or 'next-cursor' is expired.
      security:
      - Authorization: []
components:
  schemas:
    RestArchiveMail:
      type: object
      properties:
        mailingGroupId:
          type: integer
          description: Client ID
          format: int64
        mailingType:
          type: string
          description: Mailing type
        mailingToUserId:
          type: integer
          description: MailingToUser ID
          format: int64
        properties:
          type: object
          additionalProperties:
            type: string
            description: Metadata
          description: Metadata
        created:
          type: string
          description: Date and time of creation
          format: date-time
  securitySchemes:
    Authorization:
      type: apiKey
      name: Authorization
      in: header
x-readme:
  explorer-enabled: true
  proxy-enabled: true