Optimizely

Optimizely Blocklist entries API

Manage recipients on the blocklist

GitHub OpenAPI

Operations 7

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}/blacklistentries/blacklisted Check if an address is blocklisted · Check whether an address is blocklisted #
Ask an LLM
“Is this email address on my blocklist?”
“Can I check an address against the blocklist before sending?”
Tell an agent
Check whether {address} is blocklisted for client {clientId}.
Tell me if client {clientId} blocks sending to {address}.
GET /{clientId}/blacklistentries/count Count blocklist entries · Get the total number of blocklist entries #
Ask an LLM
“How many entries are on my client's blocklist?”
“Can the blocklist count include entries inherited from parent clients?”
Tell an agent
Count blocklist entries for client {clientId}.
Count blocklist entries on client {clientId} with parent clients included: {includeParent}.
GET /{clientId}/blacklistentries List blocklist entries · Get information about all blocklist entries #
Ask an LLM
“Which addresses and patterns are on my blocklist, and why?”
“Can I filter blocklist entries by pattern or reason?”
Tell an agent
List blocklist entries for client {clientId}.
List blocklist entries on client {clientId} matching pattern {pattern}.
POST /{clientId}/blacklistentries Add an address or pattern to the blocklist · Create a blocklist entry #
Ask an LLM
“How do I stop mailings from going to a certain address or domain?”
“Can I record a reason when I blocklist an address?”
Tell an agent
Blocklist {entry} for client {clientId}.
Add {entry} to the blocklist of client {clientId} with reason {reason}.
DELETE /{clientId}/blacklistentries Remove several blocklist entries · Delete multiple blocklist entries #
Ask an LLM
“Can I unblock multiple addresses in one request?”
“How do I clear a batch of entries off the blocklist?”
Tell an agent destructive · confirm first
Remove blocklist entries {entries} from client {clientId}.
Unblock all of {entries} for client {clientId}.
GET /{clientId}/blacklistentries/{entry} Get a blocklist entry's details · Get information about a blocklist entry #
Ask an LLM
“Why was a specific address added to the blocklist, and when?”
“What pattern and reason does one blocklist entry hold?”
Tell an agent
Get blocklist entry {entry} for client {clientId}.
Show reason and creation date for blocklist entry {entry} on client {clientId}.
DELETE /{clientId}/blacklistentries/{entry} Remove one blocklist entry · Delete a blocklist entry #
Ask an LLM
“How do I take a single address off the blocklist?”
“Can I unblock one pattern without touching the rest?”
Tell an agent destructive · confirm first
Delete blocklist entry {entry} for client {clientId}.
Unblock the single entry {entry} on client {clientId}.

Specifications

⚙
OpenAPI
https://artifacts.apis.io/optimizely/openapi/optimizely-blocklist-entries-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/optimizely/json-schema/optimizely-rest-blacklist-entry-schema.json
📊
JSONSchema
https://artifacts.apis.io/optimizely/json-schema/optimizely-rest-count-schema.json
📊
JSONSchema
https://artifacts.apis.io/optimizely/json-schema/optimizely-blacklist-entry-request-data-schema.json
📊
JSONSchema
https://artifacts.apis.io/optimizely/json-schema/optimizely-rest-blacklist-entry-streaming-collection-schema.json
📊
JSONSchema
https://artifacts.apis.io/optimizely/json-schema/optimizely-rest-blacklisted-entry-schema.json

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-blocklist-entries-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-blocklist-entries-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Optimizely Campaign REST Blocklist entries 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: Blocklist entries
  description: Manage recipients on the blocklist
paths:
  /{clientId}/blacklistentries/blacklisted:
    get:
      tags:
      - Blocklist entries
      summary: Check whether an address is blocklisted
      operationId: blacklisted
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: address
        in: query
        description: Address to be checked
        schema:
          type: string
      responses:
        '200':
          description: true/false as result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestBlacklistedEntry'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestBlacklistedEntry'
      security:
      - Authorization: []
  /{clientId}/blacklistentries/count:
    get:
      tags:
      - Blocklist entries
      summary: Get the total number of blocklist entries
      description: Get the total number of blocklist entries. You can choose whether to include or exclude parent clients.
      operationId: count_2
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: includeParent
        in: query
        description: 'Include parent clients in the counting<p><i>Default value</i> : false</p>'
        schema:
          type: boolean
      responses:
        '200':
          description: The number of blocklist entries was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestCount'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestCount'
      security:
      - Authorization: []
  /{clientId}/blacklistentries:
    get:
      tags:
      - Blocklist entries
      summary: Get information about all blocklist entries
      description: Get detailed information about all blocklist entries, such as pattern, reason or creation date. You can limit the maximum number of retrieved blocklist entries and sort the result by specific criteria.
      operationId: findAllBlacklistEntries
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: offset
        in: query
        description: 'Starting point of the result list <p><i>Default value</i> : 0</p>'
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: 'Maximum number of retrieved blocklist entries<p><i>Default value</i> : 100</p>'
        schema:
          type: integer
          format: int32
      - name: pattern
        in: query
        description: Matching pattern
        schema:
          type: array
          items:
            type: string
      - name: reason
        in: query
        description: Matching reason
        schema:
          type: string
      - name: sort
        in: query
        schema:
          type: string
          description: Sort result by specific criteria
          default: created
          enum:
          - pattern
          - reason
          - created
          - modified
      - name: direction
        in: query
        description: Sort order
        schema:
          type: string
          enum:
          - ASC
          - DESC
      responses:
        '200':
          description: The blocklist entries were retrieved successfully (empty result if none was found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestBlacklistEntryStreamingCollection'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestBlacklistEntryStreamingCollection'
        '400':
          description: Invalid limit request. Change the limit to less than 10000.
      security:
      - Authorization: []
    post:
      tags:
      - Blocklist entries
      summary: Create a blocklist entry
      description: Create a blocklist entry. You can specify a reason for blocklisting.
      operationId: createBlacklistEntry
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BlacklistEntryRequestData'
      responses:
        '201':
          description: The blocklist entry was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestBlacklistEntry'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestBlacklistEntry'
        '400':
          description: A required value for the entry is not provided. Check for the blocklist entry pattern and add it to the request.
      security:
      - Authorization: []
    delete:
      tags:
      - Blocklist entries
      summary: Delete multiple blocklist entries
      operationId: deleteBlacklistEntries
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: entries
        in: query
        description: List of blocklist entry patterns<p><b>Note:</b> If the blocklist entry pattern contains special characters, the pattern must be URL-encoded. For example, use the code %2f for a forward slash (/), %252f for a double slash (//), %2B for a plus sign (+) etc.</p>
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '204':
          description: The deletion was initiated successfully.
        '400':
          description: The list of entries is not provided or the number of entries has exceeded the limit. Provide an array with blocklist entries or limit the number of entries to a maximum of 1000.
      security:
      - Authorization: []
  /{clientId}/blacklistentries/{entry}:
    get:
      tags:
      - Blocklist entries
      summary: Get information about a blocklist entry
      description: Get detailed information about a blocklist entry, such as pattern, reason for blocklisting or creation date.
      operationId: getBlacklistEntry
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: entry
        in: path
        description: Blocklist entry pattern<p><b>Note:</b> If the blocklist entry pattern contains special characters, the pattern must be URL-encoded. For example, use the code %2f for a forward slash (/), %252f for a double slash (//), %2B for a plus sign (+) etc.</p>
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The blocklist entry was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestBlacklistEntry'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestBlacklistEntry'
        '404':
          description: The blocklist entry could not be found. Ensure that the required parameters such as "entry" are correct and the blocklist entry exists.
      security:
      - Authorization: []
    delete:
      tags:
      - Blocklist entries
      summary: Delete a blocklist entry
      operationId: deleteBlacklistEntry
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: entry
        in: path
        description: Blocklist entry pattern<p><b>Note:</b> If the blocklist entry pattern contains special characters, the pattern must be URL-encoded. For example, use the code %2f for a forward slash (/), %252f for a double slash (//), %2B for a plus sign (+) etc.</p>
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The blocklist entry was deleted successfully.
        '404':
          description: The blocklist entry could not be found. Ensure that the required parameter is correct and the blocklist entry exists.
      security:
      - Authorization: []
components:
  schemas:
    RestApiLink:
      type: object
      properties:
        href:
          type: string
        rel:
          type: string
    RestCount:
      type: object
      properties:
        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
        count:
          type: integer
          description: Total number
          format: int64
    RestBlacklistedEntry:
      type: object
      properties:
        blacklisted:
          type: boolean
          description: If true, the entry is blocklisted
        pattern:
          type: string
          description: Address pattern
    BlacklistEntryRequestData:
      required:
      - entry
      type: object
      properties:
        reason:
          type: string
          description: Reason for creating a blocklist entry
        entry:
          type: string
          description: Pattern of the blocklist entry. You can use * for multiple character matching or ? for single character matching. If this characters should be matched as literals they need to be escaped with a backslash (\* or \?)
    RestBlacklistEntryStreamingCollection:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/RestBlacklistEntry'
        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
    RestBlacklistEntry:
      type: object
      properties:
        mailingGroupId:
          type: integer
          description: Client ID
          format: int64
        pattern:
          type: string
          description: Pattern for all mailing addresses that push into the blocklist
        reason:
          type: string
          description: Reason for adding a pattern into the blocklist
        created:
          type: string
          description: Date and time of creation
          format: date-time
        modified:
          type: string
          description: Date and time of modification
          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
  securitySchemes:
    Authorization:
      type: apiKey
      name: Authorization
      in: header
x-readme:
  explorer-enabled: true
  proxy-enabled: true