Optimizely

Optimizely Push Notification Messages API

The Push Notification Messages API from Optimizely — 6 operation(s) for push notification messages.

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/PushNotificationMessages List push notification messages · Returns the EntitySet PushNotificationMessages #
Ask an LLM
“Which push notifications have been sent to app users?”
“Can I filter push notification messages by type or sent date?”
Tell an agent
List all push notification messages.
Show push notification messages matching {filter}.
POST /api/v1/admin/PushNotificationMessages Create a push notification message · Post a new entity to EntitySet PushNotificationMessages #
Ask an LLM
“How do I create a push notification for a specific user?”
“What fields are required to create a push notification message?”
Tell an agent
Create a {type} push notification titled {title} with body {body} and data {data}.
Send user {userProfileId} a push titled {title}, body {body}, type {type}, data {data}.
GET /api/v1/admin/PushNotificationMessages({id}) Get a push notification message · Returns the entity with the key from PushNotificationMessages #
Ask an LLM
“What did a particular push notification say and when was it sent?”
“Can I look up one push notification message by ID?”
Tell an agent
Get push notification message {id}.
Show the title and body of push message {id}.
PUT /api/v1/admin/PushNotificationMessages({id}) Replace a push notification message · Replace entity in EntitySet PushNotificationMessages #
Ask an LLM
“How do I overwrite every field of a push notification message?”
“Can I fully replace a stored push notification?”
Tell an agent
Replace push message {id} with title {title}, body {body}, type {type}, data {data}.
Overwrite push notification {id} entirely using title {title}, body {body}, type {type} and data {data}.
DELETE /api/v1/admin/PushNotificationMessages({id}) Delete a push notification message · Delete entity in EntitySet PushNotificationMessages #
Ask an LLM
“How do I delete one push notification message?”
“Does deleting a push message support an If-Match header?”
Tell an agent destructive · confirm first
Delete push notification message {id}.
Remove push message {id} if its ETag is {ifMatch}.
PATCH /api/v1/admin/PushNotificationMessages({id}) Update a push notification message · Update entity in EntitySet PushNotificationMessages #
Ask an LLM
“How do I edit the title of an existing push notification?”
“Can I change just the body text on a push message?”
Tell an agent
Update push message {id}: title {title}, body {body}, type {type}, data {data}.
Patch push notification {id} so the title reads {title} (body {body}, type {type}, data {data}).
GET /api/v1/admin/PushNotificationMessages/Default.Default() Get default values for a new push message · Call operation Default #
Ask an LLM
“What defaults does a new push notification message start with?”
“Is there a blank push notification template?”
Tell an agent
Get the default field values for a new push notification message.
Show a blank push notification record.
DELETE /api/v1/admin/pushnotificationmessages/delete Delete several push notification messages · Push notification messages delete route #
Ask an LLM
“How do I bulk delete old push notification messages?”
“Can I remove many push messages in one request?”
Tell an agent destructive · confirm first
Bulk delete push notification messages {ids}.
Permanently delete every push message in {ids}.
GET /api/v1/admin/pushnotificationmessages({key})/customproperties({custompropertyKey}) Get a custom property on a push message · Push notification messages get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property on a push notification message?”
“Can I fetch one custom field value from a push message?”
Tell an agent
Get custom property {custompropertyKey} of push message {key}.
Show the {custompropertyKey} custom property on push notification {key}.
GET /api/v1/admin/pushnotificationmessages({key})/pushnotificationlogs({pushnotificationlogKey}) Get a delivery log for a push message · Push notification messages get push notification log by key and… #
Ask an LLM
“Was a push notification actually delivered? Where's its log?”
“Can I look up a specific delivery log entry for a push message?”
Tell an agent
Get log {pushnotificationlogKey} for push message {key}.
Show delivery log entry {pushnotificationlogKey} of push notification {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-push-notification-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-push-notification-messages-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-push-notification-messages-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Push Notification Messages API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Push Notification Messages
paths:
  /api/v1/admin/PushNotificationMessages:
    get:
      tags:
      - Push Notification Messages
      summary: Returns the EntitySet PushNotificationMessages
      operationId: PushNotificationMessages_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:
      - Push Notification Messages
      summary: Post a new entity to EntitySet PushNotificationMessages
      operationId: PushNotificationMessages_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PushNotificationMessage'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PushNotificationMessages({id}):
    get:
      tags:
      - Push Notification Messages
      summary: Returns the entity with the key from PushNotificationMessages
      operationId: PushNotificationMessages_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:
      - Push Notification Messages
      summary: Replace entity in EntitySet PushNotificationMessages
      operationId: PushNotificationMessages_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.PushNotificationMessage'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Push Notification Messages
      summary: Delete entity in EntitySet PushNotificationMessages
      operationId: PushNotificationMessages_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:
      - Push Notification Messages
      summary: Update entity in EntitySet PushNotificationMessages
      operationId: PushNotificationMessages_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.PushNotificationMessage'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PushNotificationMessages/Default.Default():
    get:
      tags:
      - Push Notification Messages
      summary: Call operation Default
      operationId: PushNotificationMessages_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/pushnotificationmessages/delete:
    delete:
      tags:
      - Push Notification Messages
      operationId: PushNotificationMessages_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: Push notification messages delete route
      x-summary-source: derived
  /api/v1/admin/pushnotificationmessages({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Push Notification Messages
      operationId: PushNotificationMessages_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: Push notification messages get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/pushnotificationmessages({key})/pushnotificationlogs({pushnotificationlogKey}):
    get:
      tags:
      - Push Notification Messages
      operationId: PushNotificationMessages_GetPushNotificationLogByKeyAndPushnotificationlogkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: pushnotificationlogKey
        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: Push notification messages get push notification log by key and…
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.PushNotificationMessage:
      required:
      - title
      - body
      - data
      - type
      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
        title:
          maxLength: 250
          minLength: 0
          type: string
        body:
          type: string
        data:
          type: string
        type:
          maxLength: 50
          minLength: 0
          type: string
        sentDate:
          format: date-time
          type: string
        websiteId:
          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