Optimizely

Optimizely Email Templates API

The Email Templates API from Optimizely — 10 operation(s) for email templates.

GitHub OpenAPI

Operations 14

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/EmailTemplates List the email templates · Returns the EntitySet EmailTemplates #
Ask an LLM
“How can I see all the email templates set up in Commerce admin?”
“Can I filter the email template list by website?”
Tell an agent
List every email template.
Show the email templates matching {filter}.
POST /api/v1/admin/EmailTemplates Create a new email template · Post a new entity to EntitySet EmailTemplates #
Ask an LLM
“What do I need to supply to add a new email template?”
“Can I create an email template for a specific website?”
Tell an agent
Create an email template named {name} described as {description}.
Add email template {name} for website {websiteId} with description {description}.
GET /api/v1/admin/EmailTemplates({id}) Get one email template by id · Returns the entity with the key from EmailTemplates #
Ask an LLM
“How do I open a single email template record?”
“What details are stored for one email template?”
Tell an agent
Fetch email template {id}.
Show me everything about email template {id}.
PUT /api/v1/admin/EmailTemplates({id}) Replace an email template record · Replace entity in EntitySet EmailTemplates #
Ask an LLM
“Can I replace an entire email template record in one request?”
“Does a full replace of an email template require the name and description again?”
Tell an agent
Replace email template {id} with name {name} and description {description}.
Overwrite the whole email template {id} record.
DELETE /api/v1/admin/EmailTemplates({id}) Delete a single email template · Delete entity in EntitySet EmailTemplates #
Ask an LLM
“How do I delete one email template by id?”
“Can I guard an email template delete with an ETag check?”
Tell an agent destructive · confirm first
Delete email template {id}.
Delete email template {id} if its ETag is still {etag}.
PATCH /api/v1/admin/EmailTemplates({id}) Rename or edit part of an email template · Update entity in EntitySet EmailTemplates #
Ask an LLM
“Can I just rename an email template without replacing it?”
“Is there a partial update for an email template's description?”
Tell an agent
Rename email template {id} to {name}.
Change the description of email template {id} to {description}.
GET /api/v1/admin/EmailTemplates/Default.Default() Get default values for a new email template · Call operation Default #
Ask an LLM
“What values does a new email template record start with?”
“Is there a blank email template entity I can fill in?”
Tell an agent
Get the default field values for a new email template entity.
Show the blank email template record.
GET /api/v1/admin/EmailTemplates/Default.defaulttemplates() List built-in default templates via OData action · Call operation defaulttemplates #
Ask an LLM
“Which built-in default email templates ship with the platform, via the OData defaulttemplates function?”
“Can I call Default.defaulttemplates() to see the stock templates?”
Tell an agent
Call the OData defaulttemplates function to list stock email templates.
Show the built-in email templates using Default.defaulttemplates().
POST /api/v1/admin/EmailTemplates/Default.createdefaulttemplate Create a stock template via the OData action · Call operation createdefaulttemplate #
Ask an LLM
“How do I install one of the built-in email templates for a website with the OData createdefaulttemplate action?”
“Can the Default.createdefaulttemplate action target a specific website?”
Tell an agent
Run createdefaulttemplate to add stock template {defaultTemplate} for website {websiteId}.
Install the built-in email template {defaultTemplate} with the OData action.
GET /api/v1/admin/emailtemplates/defaultTemplates List built-in default templates via REST route · Email templates default templates 2 #
Ask an LLM
“Is there a plain REST route that lists the stock email templates?”
“What does the emailtemplates/defaultTemplates route return?”
Tell an agent
Get the default email templates from the defaultTemplates route.
List the stock email templates using the REST-style route.
POST /api/v1/admin/emailtemplates/createDefaultTemplate Create a stock template via the REST route · Email templates create default template 2 #
Ask an LLM
“Can I create a default email template through the createDefaultTemplate REST route?”
“What does posting to emailtemplates/createDefaultTemplate do?”
Tell an agent
Create a default email template using the createDefaultTemplate route.
Post to the REST createDefaultTemplate endpoint to add a stock template.
DELETE /api/v1/admin/emailtemplates/delete Delete several email templates at once · Email templates delete route #
Ask an LLM
“How do I bulk delete multiple email templates?”
“Can I remove a list of email templates by id in one call?”
Tell an agent destructive · confirm first
Bulk delete email templates {ids}.
Permanently remove every email template in {ids}.
GET /api/v1/admin/emailtemplates({key})/customproperties({custompropertyKey}) Get a custom property on an email template · Email templates get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on an email template?”
“Can I fetch one custom field from an email template?”
Tell an agent
Get custom property {custompropertyKey} of email template {key}.
Show the custom property {custompropertyKey} value on email template {key}.
GET /api/v1/admin/emailtemplates({key})/emaillists({emaillistKey}) Get an email list that uses a template · Email templates get email list by key and emaillistkey #
Ask an LLM
“Which email list is tied to a given email template?”
“Can I look up one email list through its template?”
Tell an agent
Get email list {emaillistKey} for email template {key}.
Show the email list {emaillistKey} that uses template {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-email-templates-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-templates-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-templates-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Email Templates API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Email Templates
paths:
  /api/v1/admin/EmailTemplates:
    get:
      tags:
      - Email Templates
      summary: Returns the EntitySet EmailTemplates
      operationId: EmailTemplates_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 Templates
      summary: Post a new entity to EntitySet EmailTemplates
      operationId: EmailTemplates_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.EmailTemplate'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EmailTemplates({id}):
    get:
      tags:
      - Email Templates
      summary: Returns the entity with the key from EmailTemplates
      operationId: EmailTemplates_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 Templates
      summary: Replace entity in EntitySet EmailTemplates
      operationId: EmailTemplates_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.EmailTemplate'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Email Templates
      summary: Delete entity in EntitySet EmailTemplates
      operationId: EmailTemplates_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 Templates
      summary: Update entity in EntitySet EmailTemplates
      operationId: EmailTemplates_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.EmailTemplate'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EmailTemplates/Default.Default():
    get:
      tags:
      - Email Templates
      summary: Call operation Default
      operationId: EmailTemplates_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EmailTemplates/Default.defaulttemplates():
    get:
      tags:
      - Email Templates
      summary: Call operation defaulttemplates
      operationId: EmailTemplates_DefaultTemplates_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EmailTemplates/Default.createdefaulttemplate:
    post:
      tags:
      - Email Templates
      summary: Call operation createdefaulttemplate
      operationId: EmailTemplates_CreateDefaultTemplate_1
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                defaultTemplate:
                  type: string
                websiteId:
                  format: guid
                  type: string
        description: createdefaulttemplate action parameters
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/emailtemplates/defaultTemplates:
    get:
      tags:
      - Email Templates
      operationId: EmailTemplates_DefaultTemplates_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Email templates default templates 2
      x-summary-source: derived
  /api/v1/admin/emailtemplates/createDefaultTemplate:
    post:
      tags:
      - Email Templates
      operationId: EmailTemplates_CreateDefaultTemplate_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Email templates create default template 2
      x-summary-source: derived
  /api/v1/admin/emailtemplates/delete:
    delete:
      tags:
      - Email Templates
      operationId: EmailTemplates_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 templates delete route
      x-summary-source: derived
  /api/v1/admin/emailtemplates({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Email Templates
      operationId: EmailTemplates_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 templates get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/emailtemplates({key})/emaillists({emaillistKey}):
    get:
      tags:
      - Email Templates
      operationId: EmailTemplates_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 templates get email list by key and emaillistkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.EmailTemplate:
      required:
      - name
      - description
      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
        websiteId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        contentManagerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        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