# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Optimizely Campaign REST Opt-in processes API
  version: 1.0.0
extends: openapi/optimizely-opt-in-processes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/{clientId}/optinprocesses'].get
  update:
    x-apievangelist-phrasing:
      intent: List opt-in processes
      effect: read
      questions:
      - 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?
      instructions:
      - text: List all opt-in processes for client {clientId}.
        slots:
          clientId: path.clientId
      - text: List opt-in processes for client {clientId} where has-mailing is {hasMailing}.
        slots:
          clientId: path.clientId
          hasMailing: query.hasMailing
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/optinprocesses'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an opt-in process
      effect: write
      questions:
      - 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?
      instructions:
      - text: Create a {type} opt-in process named {name} for client {clientId}.
        slots:
          type: requestBody.type
          name: requestBody.name
          clientId: path.clientId
      - text: Create opt-in process {name} ({type}) for client {clientId} using confirmation mailing {confirmationMailingId}.
        slots:
          name: requestBody.name
          type: requestBody.type
          clientId: path.clientId
          confirmationMailingId: requestBody.confirmationMailingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/optinprocesses/{optinProcessId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one opt-in process
      effect: read
      questions:
      - 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?
      instructions:
      - text: Get opt-in process {optinProcessId} for client {clientId}.
        slots:
          optinProcessId: path.optinProcessId
          clientId: path.clientId
      - text: Show the settings of opt-in process {optinProcessId} in client {clientId}.
        slots:
          optinProcessId: path.optinProcessId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/optinprocesses/{optinProcessId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an opt-in process
      effect: write
      questions:
      - 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?
      instructions:
      - text: Rename opt-in process {optinProcessId} in client {clientId} to {name} with type {type}.
        slots:
          optinProcessId: path.optinProcessId
          clientId: path.clientId
          name: requestBody.name
          type: requestBody.type
      - text: Set the confirmation URL of opt-in process {optinProcessId} (client {clientId}) to {confirmationUrl}.
        slots:
          optinProcessId: path.optinProcessId
          clientId: path.clientId
          confirmationUrl: requestBody.confirmationUrl
      method: generated
      generated: '2026-09-26'