Optimizely

Optimizely Email Messages API

The Email Messages API from Optimizely — 8 operation(s) for email messages.

GitHub OpenAPI

Operations 12

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 /api/v1/admin/EmailMessages List sent email messages · Returns the EntitySet EmailMessages #
Ask an LLM
“How do I list the email messages the commerce platform has logged?”
“Can I filter email messages by subject or sent date?”
Tell an agent
List all logged email messages.
List email messages matching {filter}.
POST /api/v1/admin/EmailMessages Record a new email message · Post a new entity to EntitySet EmailMessages #
Ask an LLM
“How do I add an email message record with a subject and body?”
“What fields does a new email message entry require?”
Tell an agent
Create an email message with subject {subject} and body {body}.
Log a new email titled {subject} sent on {sentDate}.
GET /api/v1/admin/EmailMessages({id}) Get one email message · Returns the entity with the key from EmailMessages #
Ask an LLM
“Is there a call to read a single email message by its ID?”
“Can I see the subject and body of a specific logged email?”
Tell an agent
Get email message {id}.
Show the subject and body of email {id}.
PUT /api/v1/admin/EmailMessages({id}) Replace an email message record · Replace entity in EntitySet EmailMessages #
Ask an LLM
“What's the call to overwrite an email message record completely?”
“Do I have to send both subject and body when replacing an email record?”
Tell an agent
Replace email message {id} with subject {subject} and body {body}.
Overwrite the full record of email {id}, subject {subject}.
DELETE /api/v1/admin/EmailMessages({id}) Delete one email message · Delete entity in EntitySet EmailMessages #
Ask an LLM
“How do I delete a single logged email message?”
“Can I make an email message delete conditional on its ETag?”
Tell an agent destructive · confirm first
Delete email message {id}.
Delete email {id} only if the ETag matches {etag}.
PATCH /api/v1/admin/EmailMessages({id}) Update fields on an email message · Update entity in EntitySet EmailMessages #
Ask an LLM
“How do I change just the subject of an existing email message?”
“Can I correct the sent date on an email record without replacing it?”
Tell an agent
Change the subject of email {id} to {subject}.
Set the sent date of email {id} to {sentDate}.
GET /api/v1/admin/EmailMessages/Default.Default() Get the default email message template · Call operation Default #
Ask an LLM
“What does a default, empty email message record contain?”
“Where can I get default values for a new email message?”
Tell an agent
Get the default email message template.
Show me the default fields for a new email message.
DELETE /api/v1/admin/emailmessages/delete Bulk delete email messages · Email messages delete route #
Ask an LLM
“Can I delete a batch of email messages at once?”
“Can I clear out many logged emails by passing their IDs?”
Tell an agent destructive · confirm first
Bulk delete email messages {ids}.
Remove all of these email records: {ids}.
GET /api/v1/admin/emailmessages({key})/customproperties({custompropertyKey}) Get a custom property on an email · Email messages get custom property by key and custompropertykey #
Ask an LLM
“Where would I read a custom property stored on an email message?”
“Can I fetch an extra attribute attached to a logged email?”
Tell an agent
Get custom property {prop} on email message {key}.
Show custom field {prop} for email {key}.
GET /api/v1/admin/emailmessages({key})/emailmessageaddresses({emailmessageaddressKey}) Get a recipient address of an email · Email messages get email message address by key and emailmessageaddresskey #
Ask an LLM
“Who was an email message addressed to?”
“Can I read one recipient address on a logged email?”
Tell an agent
Get address {address} on email message {key}.
Show recipient entry {address} for email {key}.
GET /api/v1/admin/emailmessages({key})/emailmessageattachments({emailmessageattachmentKey}) Get an attachment on an email · Email messages get email message attachment by key and emailmessageattachmentkey #
Ask an LLM
“Can I retrieve an attachment from a logged email message?”
“What files were attached to a particular email?”
Tell an agent
Get attachment {attachment} on email message {key}.
Show file attachment {attachment} from email {key}.
GET /api/v1/admin/emailmessages({key})/emailmessagedeliveryattempts({emailmessagedeliveryattemptKey}) Get a delivery attempt for an email · Email messages get email message delivery attempt by key and… #
Ask an LLM
“Did a particular email delivery attempt succeed?”
“Can I see the details of one send attempt for an email message?”
Tell an agent
Get delivery attempt {attempt} for email message {key}.
Show send attempt {attempt} on email {key}.

Specifications

⚙
OpenAPI
https://artifacts.apis.io/optimizely/openapi/optimizely-email-messages-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-email-messages-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-email-messages-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Email Messages API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Email Messages
paths:
  /api/v1/admin/EmailMessages:
    get:
      tags:
      - Email Messages
      summary: Returns the EntitySet EmailMessages
      operationId: EmailMessages_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Email Messages
      summary: Post a new entity to EntitySet EmailMessages
      operationId: EmailMessages_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.EmailMessage'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EmailMessages({id}):
    get:
      tags:
      - Email Messages
      summary: Returns the entity with the key from EmailMessages
      operationId: EmailMessages_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Email Messages
      summary: Replace entity in EntitySet EmailMessages
      operationId: EmailMessages_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.EmailMessage'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Email Messages
      summary: Delete entity in EntitySet EmailMessages
      operationId: EmailMessages_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Email Messages
      summary: Update entity in EntitySet EmailMessages
      operationId: EmailMessages_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.EmailMessage'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EmailMessages/Default.Default():
    get:
      tags:
      - Email Messages
      summary: Call operation Default
      operationId: EmailMessages_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/emailmessages/delete:
    delete:
      tags:
      - Email Messages
      operationId: EmailMessages_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Email messages delete route
      x-summary-source: derived
  /api/v1/admin/emailmessages({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Email Messages
      operationId: EmailMessages_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Email messages get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/emailmessages({key})/emailmessageaddresses({emailmessageaddressKey}):
    get:
      tags:
      - Email Messages
      operationId: EmailMessages_GetEmailMessageAddressByKeyAndEmailmessageaddresskey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: emailmessageaddressKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Email messages get email message address by key and emailmessageaddresskey
      x-summary-source: derived
  /api/v1/admin/emailmessages({key})/emailmessageattachments({emailmessageattachmentKey}):
    get:
      tags:
      - Email Messages
      operationId: EmailMessages_GetEmailMessageAttachmentByKeyAndEmailmessageattachmentkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: emailmessageattachmentKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Email messages get email message attachment by key and emailmessageattachmentkey
      x-summary-source: derived
  /api/v1/admin/emailmessages({key})/emailmessagedeliveryattempts({emailmessagedeliveryattemptKey}):
    get:
      tags:
      - Email Messages
      operationId: EmailMessages_GetEmailMessageDeliveryAttemptByKeyAndEmailmessagedeliveryattemptkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: emailmessagedeliveryattemptKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Email messages get email message delivery attempt by key and…
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.EmailMessage:
      required:
      - body
      - subject
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        body:
          type: string
        subject:
          maxLength: 256
          minLength: 0
          type: string
        sentDate:
          format: date-time
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query