Optimizely

Optimizely User Profile Email Lists API

The User Profile Email Lists API from Optimizely — 5 operation(s) for user profile email lists.

GitHub OpenAPI

Operations 9

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/UserProfileEmailLists List user email list subscriptions · Returns the EntitySet UserProfileEmailLists #
Ask an LLM
“Which user profiles are subscribed to which email lists?”
“Can I filter email list memberships to a single user profile?”
Tell an agent
List all user profile email list memberships.
Find email list memberships matching {filter}.
POST /api/v1/admin/UserProfileEmailLists Subscribe a user profile to an email list · Post a new entity to EntitySet UserProfileEmailLists #
Ask an LLM
“How do I add a user to an email list?”
“Can I link one user profile to several email lists?”
Tell an agent
Subscribe user profile {userProfileId} to email list {emailListId}.
Add email list {emailListId} to user {userProfileId}.
GET /api/v1/admin/UserProfileEmailLists({id}) Get a user email list membership · Returns the entity with the key from UserProfileEmailLists #
Ask an LLM
“How do I look up one user-to-email-list membership by ID?”
“Which user and list does a membership record connect?”
Tell an agent
Get email list membership {id}.
Show the user and email list for membership {id}.
PUT /api/v1/admin/UserProfileEmailLists({id}) Replace a user email list membership · Replace entity in EntitySet UserProfileEmailLists #
Ask an LLM
“How do I overwrite an email list membership record in full?”
“Does replacing a membership reset fields I omit?”
Tell an agent
Replace membership {id} to link user {userProfileId} with list {emailListId}.
Overwrite every field of email list membership {id}.
DELETE /api/v1/admin/UserProfileEmailLists({id}) Unsubscribe a user from an email list · Delete entity in EntitySet UserProfileEmailLists #
Ask an LLM
“How do I remove a user from an email list?”
“Can I delete a membership only if its ETag still matches?”
Tell an agent destructive · confirm first
Delete email list membership {id}.
Delete email list membership {id} if its ETag is {etag}.
PATCH /api/v1/admin/UserProfileEmailLists({id}) Update a user email list membership · Update entity in EntitySet UserProfileEmailLists #
Ask an LLM
“How do I switch a user's membership to a different email list?”
“Can I partially update an email list membership?”
Tell an agent
Move membership {id} to email list {emailListId}.
Change the user on membership {id} to {userProfileId}.
GET /api/v1/admin/UserProfileEmailLists/Default.Default() Get a default email list membership template · Call operation Default #
Ask an LLM
“What default values does a new email list membership start with?”
“Can I fetch a blank user email list membership template?”
Tell an agent
Fetch the default email list membership template.
Show me the defaults for a new user email list membership.
DELETE /api/v1/admin/userprofileemaillists/delete Bulk remove user email list memberships · User profile email lists delete route #
Ask an LLM
“How do I remove many users from email lists in one go?”
“Can I delete email list memberships by a list of IDs?”
Tell an agent destructive · confirm first
Bulk delete email list memberships {ids}.
Remove these email list memberships in one call: {ids}.
GET /api/v1/admin/userprofileemaillists({key})/customproperties({custompropertyKey}) Get a custom property on an email list membership · User profile email lists get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on an email list membership?”
“Can I fetch one extra property from a user email list membership?”
Tell an agent
Get custom property {custompropertyKey} on email list membership {key}.
Show email list membership {key}'s custom property {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-user-profile-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-user-profile-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-user-profile-email-lists-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 User Profile Email Lists API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: User Profile Email Lists
paths:
  /api/v1/admin/UserProfileEmailLists:
    get:
      tags:
      - User Profile Email Lists
      summary: Returns the EntitySet UserProfileEmailLists
      operationId: UserProfileEmailLists_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:
      - User Profile Email Lists
      summary: Post a new entity to EntitySet UserProfileEmailLists
      operationId: UserProfileEmailLists_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.UserProfileEmailList'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/UserProfileEmailLists({id}):
    get:
      tags:
      - User Profile Email Lists
      summary: Returns the entity with the key from UserProfileEmailLists
      operationId: UserProfileEmailLists_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:
      - User Profile Email Lists
      summary: Replace entity in EntitySet UserProfileEmailLists
      operationId: UserProfileEmailLists_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.UserProfileEmailList'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - User Profile Email Lists
      summary: Delete entity in EntitySet UserProfileEmailLists
      operationId: UserProfileEmailLists_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:
      - User Profile Email Lists
      summary: Update entity in EntitySet UserProfileEmailLists
      operationId: UserProfileEmailLists_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.UserProfileEmailList'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/UserProfileEmailLists/Default.Default():
    get:
      tags:
      - User Profile Email Lists
      summary: Call operation Default
      operationId: UserProfileEmailLists_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/userprofileemaillists/delete:
    delete:
      tags:
      - User Profile Email Lists
      operationId: UserProfileEmailLists_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: User profile email lists delete route
      x-summary-source: derived
  /api/v1/admin/userprofileemaillists({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - User Profile Email Lists
      operationId: UserProfileEmailLists_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: User profile email lists get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.UserProfileEmailList:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        userProfileId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        emailListId:
          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