Optimizely Affiliates API

The Affiliates API from Optimizely — 7 operation(s) for affiliates.

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/Affiliates List affiliate partners · Returns the EntitySet Affiliates #
Ask an LLM
“How can I see every affiliate configured in Commerce admin?”
“Can I filter the affiliate list to only active partners?”
Tell an agent
List all affiliates.
Show affiliates matching {filter}.
POST /api/v1/admin/Affiliates Add a new affiliate partner · Post a new entity to EntitySet Affiliates #
Ask an LLM
“What information do I need to register a new affiliate?”
“Can I give a new affiliate a logo image and website link?”
Tell an agent
Create affiliate {name} with website {url}.
Add affiliate {name} using logo {imagePath} and description {description}.
GET /api/v1/admin/Affiliates({id}) Get one affiliate by id · Returns the entity with the key from Affiliates #
Ask an LLM
“How do I look up a single affiliate's details?”
“What fields come back for one affiliate record?”
Tell an agent
Fetch affiliate {id}.
Show the details of affiliate {id}.
PUT /api/v1/admin/Affiliates({id}) Replace an affiliate record · Replace entity in EntitySet Affiliates #
Ask an LLM
“Can I overwrite an affiliate's whole record at once?”
“Does fully replacing an affiliate require resending its name, URL and image?”
Tell an agent
Replace affiliate {id} with name {name} and URL {url}.
Overwrite the full record for affiliate {id}.
DELETE /api/v1/admin/Affiliates({id}) Delete a single affiliate · Delete entity in EntitySet Affiliates #
Ask an LLM
“How do I delete one affiliate?”
“Can an affiliate delete be conditional on its ETag?”
Tell an agent destructive · confirm first
Delete affiliate {id}.
Delete affiliate {id} only if the ETag matches {etag}.
PATCH /api/v1/admin/Affiliates({id}) Update part of an affiliate · Update entity in EntitySet Affiliates #
Ask an LLM
“Can I just change an affiliate's website URL?”
“Is there a way to deactivate an affiliate without deleting it?”
Tell an agent
Change the URL of affiliate {id} to {url}.
Set affiliate {id} active flag to {isActive}.
GET /api/v1/admin/Affiliates/Default.Default() Get default values for a new affiliate · Call operation Default #
Ask an LLM
“What defaults does a new affiliate record start with?”
“Is there an empty affiliate template to fill in?”
Tell an agent
Get the default field values for a new affiliate.
Show the blank affiliate record.
POST /api/v1/admin/Affiliates/Default.archive Archive affiliates via the OData archive action · Call operation archive #
Ask an LLM
“How do I archive affiliates with the OData Default.archive action?”
“Can I retire several affiliates through the archive action call?”
Tell an agent destructive · confirm first
Run the OData archive action on affiliates {ids}.
Archive affiliates {ids} with Default.archive.
DELETE /api/v1/admin/affiliates/archive Archive affiliates through the archive route · Affiliates archive route #
Ask an LLM
“Is there a REST route for archiving a batch of affiliates?”
“What does a DELETE on affiliates/archive do?”
Tell an agent destructive · confirm first
Archive affiliates {ids} using the affiliates/archive route.
Send the batch archive request for affiliates {ids}.
DELETE /api/v1/admin/affiliates/delete Permanently delete several affiliates · Affiliates delete route #
Ask an LLM
“How do I bulk delete a list of affiliates?”
“Can I permanently remove multiple affiliates in one request?”
Tell an agent destructive · confirm first
Bulk delete affiliates {ids}.
Permanently delete every affiliate in {ids}.
GET /api/v1/admin/affiliates({key})/customproperties({custompropertyKey}) Get a custom property on an affiliate · Affiliates get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property on an affiliate?”
“Can I fetch one custom field value from an affiliate record?”
Tell an agent
Get custom property {custompropertyKey} of affiliate {key}.
Show the {custompropertyKey} custom property on affiliate {key}.

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-affiliates-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-affiliates-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Affiliates API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Affiliates
paths:
  /api/v1/admin/Affiliates:
    get:
      tags:
      - Affiliates
      summary: Returns the EntitySet Affiliates
      operationId: Affiliates_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:
      - Affiliates
      summary: Post a new entity to EntitySet Affiliates
      operationId: Affiliates_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.Affiliate'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Affiliates({id}):
    get:
      tags:
      - Affiliates
      summary: Returns the entity with the key from Affiliates
      operationId: Affiliates_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:
      - Affiliates
      summary: Replace entity in EntitySet Affiliates
      operationId: Affiliates_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.Affiliate'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Affiliates
      summary: Delete entity in EntitySet Affiliates
      operationId: Affiliates_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:
      - Affiliates
      summary: Update entity in EntitySet Affiliates
      operationId: Affiliates_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.Affiliate'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Affiliates/Default.Default():
    get:
      tags:
      - Affiliates
      summary: Call operation Default
      operationId: Affiliates_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/Affiliates/Default.archive:
    post:
      tags:
      - Affiliates
      summary: Call operation archive
      operationId: Affiliates_Archive
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      requestBody:
        $ref: '#/components/requestBodies/Affiliates_ArchiveParameters'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/affiliates/archive:
    delete:
      tags:
      - Affiliates
      operationId: Affiliates_ArchiveRoute
      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: Affiliates archive route
      x-summary-source: derived
  /api/v1/admin/affiliates/delete:
    delete:
      tags:
      - Affiliates
      operationId: Affiliates_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: Affiliates delete route
      x-summary-source: derived
  /api/v1/admin/affiliates({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Affiliates
      operationId: Affiliates_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: Affiliates get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.Affiliate:
      required:
      - description
      - imagePath
      - name
      - url
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        description:
          maxLength: 1024
          minLength: 0
          type: string
        imagePath:
          maxLength: 512
          minLength: 0
          type: string
        isActive:
          type: boolean
        name:
          maxLength: 256
          minLength: 0
          type: string
        replaceLogoImage:
          type: boolean
        url:
          maxLength: 1024
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  requestBodies:
    Affiliates_ArchiveParameters:
      content:
        application/json:
          schema:
            type: object
            properties: {}
      description: archive action parameters
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query