Optimizely

Optimizely Email Lists API

The Email Lists API from Optimizely — 7 operation(s) for email lists.

GitHub OpenAPI

Operations 11

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/EmailLists List email lists · Returns the EntitySet EmailLists #
Ask an LLM
“Which email lists are configured in the Optimizely Configured Commerce admin?”
“Can I filter email lists to only those customers can subscribe to?”
Tell an agent
List all email lists.
List email lists matching {filter}, sorted by {orderby}.
POST /api/v1/admin/EmailLists Create an email list · Post a new entity to EntitySet EmailLists #
Ask an LLM
“What do I need to set up a new email list with its subject and sender address?”
“Can I attach an email template to a list when I create it?”
Tell an agent
Create email list {name} described as {description} with subject {subject} from {fromAddress}.
Add a subscribable email list {name} using template {emailTemplateId}.
GET /api/v1/admin/EmailLists({id}) Get one email list by ID · Returns the entity with the key from EmailLists #
Ask an LLM
“How do I look up a single email list's subject and sender by its ID?”
“Can I expand related records when fetching one email list?”
Tell an agent
Show email list {id}.
Fetch email list {id} with {expand} expanded.
PUT /api/v1/admin/EmailLists({id}) Replace an email list record entirely · Replace entity in EntitySet EmailLists #
Ask an LLM
“Can I overwrite an email list with a completely new set of values?”
“What happens to email list fields I omit when replacing the whole record?”
Tell an agent
Replace email list {id} with a full record named {name}, subject {subject}.
Overwrite all fields of email list {id}, setting the sender to {fromAddress}.
DELETE /api/v1/admin/EmailLists({id}) Delete a single email list · Delete entity in EntitySet EmailLists #
Ask an LLM
“How do I remove one email list by its ID?”
“Can I make an email list delete conditional on an ETag?”
Tell an agent destructive · confirm first
Delete email list {id}.
Delete email list {id} only if its ETag matches {etag}.
PATCH /api/v1/admin/EmailLists({id}) Update selected fields on an email list · Update entity in EntitySet EmailLists #
Ask an LLM
“Can I change just the subject line of an email list?”
“How would I stop customers from subscribing to an existing list?”
Tell an agent
Patch email list {id} so its subject is {subject}.
Update email list {id} to set can subscribe to {canSubscribe}.
GET /api/v1/admin/EmailLists/Default.Default() Get default values for a new email list · Call operation Default #
Ask an LLM
“What defaults does the admin pre-fill for an email list before I create one?”
“Where do I get a blank email list template?”
Tell an agent
Get the default email list template.
Show me the pre-filled defaults for a new email list.
DELETE /api/v1/admin/emaillists/delete Bulk delete email lists by ID · Email lists delete route #
Ask an LLM
“How do I delete several email lists in one request?”
“Can I bulk-remove email lists by passing a list of IDs?”
Tell an agent destructive · confirm first
Bulk delete email lists {ids}.
Permanently remove the email lists with IDs {ids}.
GET /api/v1/admin/emaillists({key})/customproperties({custompropertyKey}) Get a custom property on an email list · Email lists get custom property by key and custompropertykey #
Ask an LLM
“How can I read one custom property stored on an email list?”
“Can I select specific fields of an email list's custom property?”
Tell an agent
Show custom property {custompropertyKey} on email list {key}.
Fetch email list {key}'s custom property {custompropertyKey}, selecting {select}.
GET /api/v1/admin/emaillists({key})/emailsubscribers({emailsubscriberKey}) Get a subscriber on an email list · Email lists get email subscriber by key and emailsubscriberkey #
Ask an LLM
“Is a particular subscriber on one of my email lists?”
“Can I fetch one email subscriber's record through its list?”
Tell an agent
Show subscriber {emailsubscriberKey} on email list {key}.
Fetch email list {key}'s subscriber {emailsubscriberKey} with {expand} expanded.
GET /api/v1/admin/emaillists({key})/userprofiles({userprofileKey}) Get a user profile linked to an email list · Email lists get user profile by key and userprofilekey #
Ask an LLM
“Which admin user profile is associated with an email list?”
“Can I look up one user profile through the email list it belongs to?”
Tell an agent
Show user profile {userprofileKey} linked to email list {key}.
Fetch email list {key}'s user profile {userprofileKey}, selecting {select}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-email-lists-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-lists-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-lists-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Email Lists API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Email Lists
paths:
  /api/v1/admin/EmailLists:
    get:
      tags:
      - Email Lists
      summary: Returns the EntitySet EmailLists
      operationId: EmailLists_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 Lists
      summary: Post a new entity to EntitySet EmailLists
      operationId: EmailLists_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.EmailList'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EmailLists({id}):
    get:
      tags:
      - Email Lists
      summary: Returns the entity with the key from EmailLists
      operationId: EmailLists_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 Lists
      summary: Replace entity in EntitySet EmailLists
      operationId: EmailLists_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.EmailList'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Email Lists
      summary: Delete entity in EntitySet EmailLists
      operationId: EmailLists_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 Lists
      summary: Update entity in EntitySet EmailLists
      operationId: EmailLists_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.EmailList'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EmailLists/Default.Default():
    get:
      tags:
      - Email Lists
      summary: Call operation Default
      operationId: EmailLists_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/emaillists/delete:
    delete:
      tags:
      - Email Lists
      operationId: EmailLists_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 lists delete route
      x-summary-source: derived
  /api/v1/admin/emaillists({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Email Lists
      operationId: EmailLists_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 lists get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/emaillists({key})/emailsubscribers({emailsubscriberKey}):
    get:
      tags:
      - Email Lists
      operationId: EmailLists_GetEmailSubscriberByKeyAndEmailsubscriberkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: emailsubscriberKey
        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 lists get email subscriber by key and emailsubscriberkey
      x-summary-source: derived
  /api/v1/admin/emaillists({key})/userprofiles({userprofileKey}):
    get:
      tags:
      - Email Lists
      operationId: EmailLists_GetUserProfileByKeyAndUserprofilekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: userprofileKey
        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 lists get user profile by key and userprofilekey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.EmailList:
      required:
      - name
      - description
      - subject
      - fromAddress
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 100
          minLength: 0
          type: string
        description:
          maxLength: 250
          minLength: 0
          type: string
        subject:
          maxLength: 250
          minLength: 0
          type: string
        fromAddress:
          maxLength: 100
          minLength: 0
          type: string
        emailTemplateId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        canSubscribe:
          type: boolean
        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