Optimizely Custom blocklists API

Manage custom blocklists

Documentation 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 /{clientId}/customblacklists List custom blocklists · Get information about all custom blocklists #

Ask an LLM

“Which custom blocklists does my Optimizely client have, and what hash algorithm does each use?”

“Can I limit the blocklists returned to one folder?”

Tell an agent

List custom blocklists for client {clientId}.

List up to {limit} custom blocklists in folder {folderId} for client {clientId}.

POST /{clientId}/customblacklists Create a custom blocklist · Create a custom blocklist #

Ask an LLM

“How do I create a new blocklist to keep certain recipients out of mailings?”

“Can a custom blocklist store hashed patterns instead of plain ones?”

Tell an agent

Create a custom blocklist named {name} for client {clientId}.

Create blocklist {name} for client {clientId} using hash algorithm {hashAlgorithm}.

GET /{clientId}/customblacklists/{customBlacklistId}/entries List entries in a custom blocklist · Get information about all entries of a custom blocklist #

Ask an LLM

“What patterns are in a custom blocklist, and why was each blocked?”

“Can I search a blocklist's entries for a matching pattern?”

Tell an agent

List entries in blocklist {customBlacklistId} for client {clientId}.

Find entries in blocklist {customBlacklistId} of client {clientId} matching {matchingPattern}.

POST /{clientId}/customblacklists/{customBlacklistId}/entries Add patterns to a custom blocklist · Create custom blocklist entries #

Ask an LLM

“How do I block new email addresses or domains by adding them to a blocklist?”

“Can I record a reason when adding blocklist patterns?”

Tell an agent

Add patterns {patterns} to blocklist {customBlacklistId} for client {clientId}.

Block {patterns} in blocklist {customBlacklistId} of client {clientId} with reason {reason}.

DELETE /{clientId}/customblacklists/{customBlacklistId}/entries Clear all entries from a custom blocklist · Delete all entries from a custom blocklist #

Ask an LLM

“How do I empty a blocklist completely while keeping the list itself?”

“Can I wipe every pattern from a custom blocklist at once?”

Tell an agent destructive · confirm first

Remove all entries from blocklist {customBlacklistId} for client {clientId}.

Wipe blocklist {customBlacklistId} of client {clientId} clean.

GET /{clientId}/customblacklists/{customBlacklistId}/entries/{customBlacklistEntryId} Get one custom blocklist entry · Get information about a custom blocklist entry #

Ask an LLM

“When was a specific blocklist entry created and for what reason?”

“How do I read a single entry of a custom blocklist?”

Tell an agent

Get entry {customBlacklistEntryId} of blocklist {customBlacklistId} for client {clientId}.

Show why entry {customBlacklistEntryId} is in blocklist {customBlacklistId} (client {clientId}).

POST /{clientId}/customblacklists/{customBlacklistId}/entries/{customBlacklistEntryId} Update a custom blocklist entry's reason · Update a custom blocklist entry #

Ask an LLM

“How do I change the reason recorded on a blocklist entry?”

“Can I edit an existing blocklist entry instead of recreating it?”

Tell an agent

Set the reason on entry {customBlacklistEntryId} in blocklist {customBlacklistId} for client {clientId} to {reason}.

Update blocklist entry {customBlacklistEntryId} in list {customBlacklistId} of client {clientId}.

DELETE /{clientId}/customblacklists/{customBlacklistId}/entries/{customBlacklistEntryId} Remove one entry from a custom blocklist · Delete a custom blocklist entry #

Ask an LLM

“How do I unblock a single address by deleting its blocklist entry?”

“Can I remove just one pattern from a blocklist?”

Tell an agent destructive · confirm first

Delete entry {customBlacklistEntryId} from blocklist {customBlacklistId} for client {clientId}.

Unblock entry {customBlacklistEntryId} in blocklist {customBlacklistId} of client {clientId}.

GET /{clientId}/customblacklists/{customBlacklistId} Get a custom blocklist · Get information about a custom blocklist #

Ask an LLM

“What is the name and hash algorithm of a specific blocklist?”

“How do I fetch details of one custom blocklist?”

Tell an agent

Get blocklist {customBlacklistId} for client {clientId}.

Show the hash algorithm of blocklist {customBlacklistId} (client {clientId}).

POST /{clientId}/customblacklists/{customBlacklistId} Rename or rehash a custom blocklist · Update a custom blocklist #

Ask an LLM

“How do I rename an existing custom blocklist?”

“Can I change the hash algorithm a blocklist uses?”

Tell an agent

Rename blocklist {customBlacklistId} for client {clientId} to {name}.

Update blocklist {customBlacklistId} of client {clientId}: name {name}, hash algorithm {hashAlgorithm}.

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-custom-blocklists-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-custom-blocklists-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

openapi: 3.2.0
info:
  title: Optimizely Campaign REST Custom blocklists API
  description: This documentation lists all available resources and endpoints of the Optimizely Campaign REST API.
  version: '1'
servers:
- url: https://api.campaign.episerver.net/rest
tags:
- name: Custom blocklists
  description: Manage custom blocklists
paths:
  /{clientId}/customblacklists:
    get:
      tags:
      - Custom blocklists
      summary: Get information about all custom blocklists
      description: Get detailed information about all custom blocklists, such as name or hash algorithm. You can limit the number of retrieved custom blocklists and set the starting point of the result list.
      operationId: selectCustomBlacklists
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: limit
        in: query
        description: 'Maximum number of retrieved custom blocklists <p><i>Default value</i> : 100</p>'
        schema:
          type: integer
          format: int32
      - name: folderId
        in: query
        description: Filter custom blocklists assigned to a folder
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The custom blocklists were retrieved successfully (empty result if none was found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklistStreamingCollection'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklistStreamingCollection'
        '400':
          description: Invalid limit request. Change the limit to less than 10000.
      security:
      - Authorization: []
    post:
      tags:
      - Custom blocklists
      summary: Create a custom blocklist
      operationId: createCustomBlacklist
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomBlacklistRequestData'
      responses:
        '201':
          description: The custom blocklist was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklist'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklist'
      security:
      - Authorization: []
  /{clientId}/customblacklists/{customBlacklistId}/entries:
    get:
      tags:
      - Custom blocklists
      summary: Get information about all entries of a custom blocklist
      description: Get detailed information about all entries of a custom blocklist, such as pattern, reason for blocklisting or creation date.
      operationId: selectCustomBlacklistEntries
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: 'Custom blocklist entries offset <p><i>Default value</i> : 0</p>'
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: 'Maximum number of retrieved custom blocklist entries <p><i>Default value</i> : 100</p>'
        schema:
          type: integer
          format: int32
      - name: exactPattern
        in: query
        description: Exact pattern
        schema:
          type: string
      - name: matchingPattern
        in: query
        description: Matching pattern
        schema:
          type: string
      - name: sort
        in: query
        description: Sort result by specific criteria
        schema:
          type: string
          default: created
          enum:
          - pattern
          - reason
          - created
      - name: direction
        in: query
        description: Sort order
        schema:
          type: string
          enum:
          - ASC
          - DESC
      - name: customBlacklistId
        in: path
        description: Custom blocklist ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The custom blocklist entries were retrieved successfully (empty result if none was found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklistEntryStreamingCollection'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklistEntryStreamingCollection'
        '400':
          description: Invalid limit request. Change the limit to less than 10000.
      security:
      - Authorization: []
    post:
      tags:
      - Custom blocklists
      summary: Create custom blocklist entries
      operationId: createBlacklistEntries
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: customBlacklistId
        in: path
        description: Custom blocklist ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateCustomBlacklistEntriesRequestData'
      responses:
        '200':
          description: The custom blocklist entries were created successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RestCustomBlacklistEntry'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RestCustomBlacklistEntry'
      security:
      - Authorization: []
    delete:
      tags:
      - Custom blocklists
      summary: Delete all entries from a custom blocklist
      operationId: wipeCustomBlacklistEntries
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: customBlacklistId
        in: path
        description: Custom blocklist ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: The custom blocklist was cleared successfully.
      security:
      - Authorization: []
  /{clientId}/customblacklists/{customBlacklistId}/entries/{customBlacklistEntryId}:
    get:
      tags:
      - Custom blocklists
      summary: Get information about a custom blocklist entry
      description: Get detailed information about a custom blocklist entry, such as pattern, reason for blocklisting or creation date.
      operationId: getCustomBlacklistEntry
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: customBlacklistEntryId
        in: path
        description: Custom blocklist entry ID
        required: true
        schema:
          type: integer
          format: int64
      - name: customBlacklistId
        in: path
        description: Custom blocklist ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The custom blocklist entry was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklistEntry'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklistEntry'
        '404':
          description: The custom blocklist entry could not be found. Ensure that the required parameters such as "customBlacklistId" are correct and the custom blocklist entry exists.
      security:
      - Authorization: []
    post:
      tags:
      - Custom blocklists
      summary: Update a custom blocklist entry
      description: Update information of a custom blocklist entry, such as pattern or reason for blocklisting.
      operationId: updateCustomBlacklistEntry
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: customBlacklistEntryId
        in: path
        description: Custom blocklist entry ID
        required: true
        schema:
          type: integer
          format: int64
      - name: customBlacklistId
        in: path
        description: Custom blocklist ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomBlacklistEntryRequestData'
      responses:
        '200':
          description: The custom blocklist entry was updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklistEntry'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklistEntry'
        '404':
          description: The custom blocklist entry could not be found. Ensure that the required parameters such as "customBlacklistId" are correct and the custom blocklist entry exists.
      security:
      - Authorization: []
    delete:
      tags:
      - Custom blocklists
      summary: Delete a custom blocklist entry
      operationId: deleteCustomBlacklistEntry
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: customBlacklistEntryId
        in: path
        description: Custom blocklist entry ID
        required: true
        schema:
          type: integer
          format: int64
      - name: customBlacklistId
        in: path
        description: Custom blocklist ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: The custom blocklist entry was deleted successfully.
        '404':
          description: The custom blocklist entry could not be found. Ensure that the required parameters such as "customBlacklistId" are correct and the custom blocklist entry exists.
      security:
      - Authorization: []
  /{clientId}/customblacklists/{customBlacklistId}:
    get:
      tags:
      - Custom blocklists
      summary: Get information about a custom blocklist
      description: Get detailed information about a custom blocklist, such as name or hash algorithm.
      operationId: getCustomBlacklist
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: customBlacklistId
        in: path
        description: Custom blocklist ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The custom blocklist was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklist'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklist'
        '404':
          description: The custom blocklist could not be found. Ensure that the required parameters such as "customBlacklistId" are correct and the custom blocklist exists.
        '409':
          description: The custom blocklist could not be transmitted. Ensure that the required parameters such as "customBlacklistId" are correct and the custom blocklist exists.
      security:
      - Authorization: []
    post:
      tags:
      - Custom blocklists
      summary: Update a custom blocklist
      description: Update information of a custom blocklist, such as name or hash algorithm.
      operationId: updateCustomBlacklist
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: integer
          format: int64
      - name: customBlacklistId
        in: path
        description: Custom blocklist ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomBlacklistRequestData'
      responses:
        '200':
          description: The custom blocklist was updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklist'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestCustomBlacklist'
      security:
      - Authorization: []
components:
  schemas:
    RestCustomBlacklistEntry:
      type: object
      properties:
        id:
          type: integer
          format: int64
        pattern:
          type: string
          description: Pattern for all mailing addresses that push into a custom blocklist
        reason:
          type: string
          description: Reason for adding a pattern into a custom blocklist
        created:
          type: string
          description: Creation date
          format: date-time
        modified:
          type: string
          description: Modification date
          format: date-time
        links:
          type: array
          items:
            type: object
            properties:
              uriBuilder:
                type: object
              rels:
                type: array
                items:
                  type: string
              rel:
                type: string
              type:
                type: string
              params:
                type: object
                additionalProperties:
                  type: string
              title:
                type: string
              uri:
                type: string
                format: uri
    CustomBlacklistEntryRequestData:
      type: object
      properties:
        reason:
          type: string
          description: Reason for creating a custom blocklist entry
    RestApiLink:
      type: object
      properties:
        href:
          type: string
        rel:
          type: string
    CustomBlacklistRequestData:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: Name of the custom blocklist
        hashAlgorithm:
          type: string
          description: Hash algorithm to be used. NONE by default.
          enum:
          - NONE
          - MD5
          - SHA1
          - SHA2_256
          - SHA2_512
          - SHA2_256_OF_MD5_AND_DATA
    CreateCustomBlacklistEntriesRequestData:
      required:
      - patterns
      type: object
      properties:
        patterns:
          type: array
          description: Patterns of the custom blocklist entries
          items:
            type: string
            description: Patterns of the custom blocklist entries
        reason:
          type: string
          description: Reason for creating a custom blocklist entry
    RestCustomBlacklistStreamingCollection:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/RestCustomBlacklist'
        links:
          type: array
          writeOnly: true
          items:
            $ref: '#/components/schemas/RestApiLink'
        count:
          type: integer
          format: int32
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
    RestCustomBlacklistEntryStreamingCollection:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/RestCustomBlacklistEntry'
        links:
          type: array
          writeOnly: true
          items:
            $ref: '#/components/schemas/RestApiLink'
        count:
          type: integer
          format: int32
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
    RestCustomBlacklist:
      type: object
      properties:
        id:
          type: integer
          description: Custom blocklist ID
          format: int64
        name:
          type: string
          description: Name of the custom blocklist
        hashAlgorithm:
          type: string
          description: Hash algorithm of the custom blocklist
          enum:
          - NONE
          - MD5
          - SHA1
          - SHA2_256
          - SHA2_512
          - SHA2_256_OF_MD5_AND_DATA
        created:
          type: string
          description: Creation date
          format: date-time
        modified:
          type: string
          description: Modification date
          format: date-time
        links:
          type: array
          description: Restful links
          items:
            type: object
            properties:
              uriBuilder:
                type: object
              rels:
                type: array
                items:
                  type: string
              rel:
                type: string
              type:
                type: string
              params:
                type: object
                additionalProperties:
                  type: string
              title:
                type: string
              uri:
                type: string
                format: uri
            description: Restful links
  securitySchemes:
    Authorization:
      type: apiKey
      name: Authorization
      in: header
x-readme:
  explorer-enabled: true
  proxy-enabled: true