Optimizely

Optimizely Email Subscribers API

The Email Subscribers API from Optimizely — 6 operation(s) for email subscribers.

GitHub OpenAPI

Operations 10

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/EmailSubscribers List email subscribers · Returns the EntitySet EmailSubscribers #
Ask an LLM
“Who is subscribed to emails in Optimizely Commerce?”
“Can I search subscribers for a particular email domain?”
Tell an agent
List all email subscribers.
Show email subscribers matching {filter}.
POST /api/v1/admin/EmailSubscribers Add an email subscriber · Post a new entity to EntitySet EmailSubscribers #
Ask an LLM
“How do I add a new email address to the subscriber list?”
“Is an email address all that's needed to create a subscriber?”
Tell an agent
Subscribe {email}.
Create an email subscriber for {email}.
GET /api/v1/admin/EmailSubscribers({id}) Get one email subscriber · Returns the entity with the key from EmailSubscribers #
Ask an LLM
“What is stored about a single email subscriber?”
“Can I look up a subscriber record by its id?”
Tell an agent
Fetch email subscriber {id}.
Show the address of subscriber {id}.
PUT /api/v1/admin/EmailSubscribers({id}) Replace an email subscriber record · Replace entity in EntitySet EmailSubscribers #
Ask an LLM
“Can I overwrite an email subscriber record entirely?”
“Does a full replace of a subscriber need the email resent?”
Tell an agent
Replace subscriber {id} with email {email}.
Overwrite the full record of email subscriber {id}.
DELETE /api/v1/admin/EmailSubscribers({id}) Remove one email subscriber · Delete entity in EntitySet EmailSubscribers #
Ask an LLM
“How do I delete a single email subscriber?”
“Can removing a subscriber be conditional on its ETag?”
Tell an agent destructive · confirm first
Delete email subscriber {id}.
Delete subscriber {id} only if its ETag is {etag}.
PATCH /api/v1/admin/EmailSubscribers({id}) Change a subscriber's email address · Update entity in EntitySet EmailSubscribers #
Ask an LLM
“Can I correct a typo in a subscriber's email address?”
“Is there a partial update for an existing email subscriber?”
Tell an agent
Change the email of subscriber {id} to {email}.
Update subscriber {id} so the address reads {email}.
GET /api/v1/admin/EmailSubscribers/Default.Default() Get default values for a new subscriber · Call operation Default #
Ask an LLM
“What defaults does a new email subscriber record start with?”
“Is there a blank email subscriber template?”
Tell an agent
Get the default field values for a new email subscriber.
Show the empty subscriber template.
DELETE /api/v1/admin/emailsubscribers/delete Bulk delete email subscribers · Email subscribers delete route #
Ask an LLM
“Can I remove many email subscribers at once?”
“Is there a batch delete for subscribers by a list of ids?”
Tell an agent destructive · confirm first
Bulk delete email subscribers {ids}.
Permanently delete every subscriber in {ids}.
GET /api/v1/admin/emailsubscribers({key})/customproperties({custompropertyKey}) Get a custom property on a subscriber · Email subscribers get custom property by key and custompropertykey #
Ask an LLM
“How can I read a custom property stored on an email subscriber?”
“Can I fetch one custom field value from a subscriber record?”
Tell an agent
Get custom property {custompropertyKey} of subscriber {key}.
Show the {custompropertyKey} custom property on email subscriber {key}.
GET /api/v1/admin/emailsubscribers({key})/emaillists({emaillistKey}) Get an email list a subscriber belongs to · Email subscribers get email list by key and emaillistkey #
Ask an LLM
“Which email lists is a subscriber on?”
“Can I check a subscriber's membership in one specific list?”
Tell an agent
Get email list {emaillistKey} for subscriber {key}.
Show list {emaillistKey} that subscriber {key} belongs to.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-email-subscribers-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-subscribers-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-email-subscribers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Email Subscribers API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Email Subscribers
paths:
  /api/v1/admin/EmailSubscribers:
    get:
      tags:
      - Email Subscribers
      summary: Returns the EntitySet EmailSubscribers
      operationId: EmailSubscribers_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 Subscribers
      summary: Post a new entity to EntitySet EmailSubscribers
      operationId: EmailSubscribers_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.EmailSubscriber'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EmailSubscribers({id}):
    get:
      tags:
      - Email Subscribers
      summary: Returns the entity with the key from EmailSubscribers
      operationId: EmailSubscribers_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 Subscribers
      summary: Replace entity in EntitySet EmailSubscribers
      operationId: EmailSubscribers_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.EmailSubscriber'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Email Subscribers
      summary: Delete entity in EntitySet EmailSubscribers
      operationId: EmailSubscribers_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 Subscribers
      summary: Update entity in EntitySet EmailSubscribers
      operationId: EmailSubscribers_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.EmailSubscriber'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EmailSubscribers/Default.Default():
    get:
      tags:
      - Email Subscribers
      summary: Call operation Default
      operationId: EmailSubscribers_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/emailsubscribers/delete:
    delete:
      tags:
      - Email Subscribers
      operationId: EmailSubscribers_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 subscribers delete route
      x-summary-source: derived
  /api/v1/admin/emailsubscribers({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Email Subscribers
      operationId: EmailSubscribers_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 subscribers get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/emailsubscribers({key})/emaillists({emaillistKey}):
    get:
      tags:
      - Email Subscribers
      operationId: EmailSubscribers_GetEmailListByKeyAndEmaillistkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: emaillistKey
        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 subscribers get email list by key and emaillistkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.EmailSubscriber:
      required:
      - email
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        email:
          maxLength: 256
          minLength: 0
          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