Optimizely Opt-in processes API

View, update and create opt-in processes

Documentation GitHub OpenAPI

Operations 4

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}/optinprocesses List opt-in processes · Get information about all opt-in processes #

Ask an LLM

“Which double opt-in processes are set up for my Optimizely Campaign client?”

“Can I list only the opt-in processes that have a confirmation mailing?”

Tell an agent

List all opt-in processes for client {clientId}.

List opt-in processes for client {clientId} where has-mailing is {hasMailing}.

POST /{clientId}/optinprocesses Create an opt-in process · Create an opt-in process #

Ask an LLM

“How do I set up a new opt-in process for newsletter sign-ups?”

“Can I attach a confirmation mailing and a confirmation page URL to an opt-in process?”

Tell an agent

Create a {type} opt-in process named {name} for client {clientId}.

Create opt-in process {name} ({type}) for client {clientId} using confirmation mailing {confirmationMailingId}.

GET /{clientId}/optinprocesses/{optinProcessId} Get one opt-in process · Get information about an opt-in process #

Ask an LLM

“How do I see the type and creation date of a specific opt-in process?”

“What details come back for a single opt-in process?”

Tell an agent

Get opt-in process {optinProcessId} for client {clientId}.

Show the settings of opt-in process {optinProcessId} in client {clientId}.

POST /{clientId}/optinprocesses/{optinProcessId} Update an opt-in process · Update an opt-in process #

Ask an LLM

“Can I rename an existing opt-in process or change its description?”

“How do I switch the confirmation page URL on an opt-in process I already have?”

Tell an agent

Rename opt-in process {optinProcessId} in client {clientId} to {name} with type {type}.

Set the confirmation URL of opt-in process {optinProcessId} (client {clientId}) to {confirmationUrl}.

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-opt-in-processes-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-opt-in-processes-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 Opt-in processes 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: Opt-in processes
  description: View, update and create opt-in processes
paths:
  /{clientId}/optinprocesses:
    get:
      tags:
      - Opt-in processes
      summary: Get information about all opt-in processes
      description: Get detailed information about all opt-in processes, such as type, title or creation date.
      operationId: selectOptinProcesses
      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 opt-in processes <p><i>Default value</i> : 100</p>'
        schema:
          type: integer
          format: int32
      - name: hasMailing
        in: query
        description: Get all opt-in processes associated with a mailing
        schema:
          type: boolean
      responses:
        '200':
          description: The opt-in processes were retrieved successfully (empty result if none was found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestOptinProcessStreamingCollection'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestOptinProcessStreamingCollection'
        '400':
          description: Invalid limit request. Change the limit to less than 10000.
      security:
      - Authorization: []
    post:
      tags:
      - Opt-in processes
      summary: Create an opt-in process
      description: Create an opt-in process. You can specify name, type or registration page.
      operationId: createOptinProcess
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OptinProcessRequestData'
      responses:
        '201':
          description: The opt-in process was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestOptinProcess'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestOptinProcess'
        '404':
          description: The confirmation mailing could not be found. Ensure that the required parameters such as "confirmationMailingId" are correct and the confirmation mailing exists.
      security:
      - Authorization: []
  /{clientId}/optinprocesses/{optinProcessId}:
    get:
      tags:
      - Opt-in processes
      summary: Get information about an opt-in process
      description: Get detailed information about an opt-in process, such as type, title or creation date.
      operationId: getOptinProcess
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: optinProcessId
        in: path
        description: Opt-in process ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: The opt-in process was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestOptinProcess'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestOptinProcess'
        '409':
          description: The indicated opt-in process is not assigned to the indicated client. Ensure that "clientId" and "optinProcessId" are correct and that the "optinProcessId" is assigned to the indicated client.
      security:
      - Authorization: []
    post:
      tags:
      - Opt-in processes
      summary: Update an opt-in process
      description: Update information of an opt-in process, such as name, description or type.
      operationId: updateOptinProcess
      parameters:
      - name: clientId
        in: path
        description: Client ID
        required: true
        schema:
          type: string
      - name: optinProcessId
        in: path
        description: Opt-in process ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OptinProcessRequestData'
      responses:
        '200':
          description: The opt-in process was updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestOptinProcess'
            application/vnd.optivo.broadmail.v1+json:
              schema:
                $ref: '#/components/schemas/RestOptinProcess'
      security:
      - Authorization: []
components:
  schemas:
    RestOptinProcessStreamingCollection:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/RestOptinProcess'
        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
    RestOptinProcess:
      type: object
      properties:
        id:
          type: integer
          description: ID of the opt-in process
          format: int64
        name:
          type: string
          description: Name of the opt-in process
        description:
          type: string
          description: Description of the opt-in process
        type:
          type: string
          description: Type of the opt-in process
        confirmationMailingId:
          type: integer
          description: ID of the mailing that sends the confirmation email (only opt-in processes of the type "double" or "confirmed")
          format: int64
        confirmationUrl:
          type: string
          description: Confirmation URL of the opt-in process (only opt-in processes of the type "double")
        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
    RestApiLink:
      type: object
      properties:
        href:
          type: string
        rel:
          type: string
    OptinProcessRequestData:
      required:
      - name
      - type
      type: object
      properties:
        confirmationMailingId:
          type: integer
          description: ID of the mailing that is used for the opt-in process (only opt-in processes of type "confirmed" or "double")
          format: int64
        confirmationUrl:
          type: string
          description: URL of the confirmation page to which the recipient is directed to complete the registration process (only opt-in processes of type "double")
        name:
          type: string
          description: Internal name of the opt-in process
        type:
          type: string
          description: Type of the opt-in process
          enum:
          - single
          - confirmed
          - double
        description:
          type: string
          description: Internal description of the opt-in process
  securitySchemes:
    Authorization:
      type: apiKey
      name: Authorization
      in: header
x-readme:
  explorer-enabled: true
  proxy-enabled: true