# 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 Click profiles API
  version: 1.0.0
extends: openapi/optimizely-click-profiles-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: 7
- target: $.paths['/{clientId}/clickprofiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List click profiles
      effect: read
      questions:
      - Which click profiles exist for categorizing link clicks in Optimizely Campaign?
      - Can I limit the click profiles returned to ones in a particular folder?
      - What rule pattern and rule type does each click profile use?
      instructions:
      - text: List click profiles for client {clientId}.
        slots:
          clientId: path.clientId
      - text: Show up to {limit} click profiles in folder {folderId} for client {clientId}.
        slots:
          limit: query.limit
          folderId: query.folderId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/clickprofiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a click profile
      effect: write
      questions:
      - How do I set up a new click profile to tag links in my mailings?
      - Can a new click profile match links by a rule pattern?
      instructions:
      - text: Create click profile {name} for client {clientId}.
        slots:
          name: requestBody.name
          clientId: path.clientId
      - text: Create click profile {name} for client {clientId} with rule type {ruleType} and pattern {rulePattern}.
        slots:
          name: requestBody.name
          clientId: path.clientId
          ruleType: requestBody.ruleType
          rulePattern: requestBody.rulePattern
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/clickprofiles/{clickProfileId}/assignedlinks'].get
  update:
    x-apievangelist-phrasing:
      intent: List links assigned to a click profile
      effect: read
      questions:
      - Which mailing links is a click profile attached to?
      - Can I search a click profile's assigned links by URL pattern or mailing?
      instructions:
      - text: Show the links assigned to click profile {clickProfileId} for client {clientId}.
        slots:
          clickProfileId: path.clickProfileId
          clientId: path.clientId
      - text: List links on click profile {clickProfileId} from mailings {mailingIds} for client {clientId}.
        slots:
          clickProfileId: path.clickProfileId
          mailingIds: query.mailingIds
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/clickprofiles/{clickProfileId}/assignedlinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign links to a click profile
      effect: write
      questions:
      - How do I attach specific links to a click profile?
      - Can I assign several links to one click profile at once?
      instructions:
      - text: Assign links {linkIds} to click profile {clickProfileId} for client {clientId}.
        slots:
          linkIds: requestBody.linkIds
          clickProfileId: path.clickProfileId
          clientId: path.clientId
      - text: Attach link ids {linkIds} to click profile {clickProfileId} in client {clientId}.
        slots:
          linkIds: requestBody.linkIds
          clickProfileId: path.clickProfileId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/clickprofiles/{clickProfileId}/assignedlinks'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign links from a click profile
      effect: destructive
      questions:
      - How can I detach links from a click profile without deleting the profile?
      - Is it possible to remove only some of a click profile's links?
      instructions:
      - text: Unassign links {linkIds} from click profile {clickProfileId} for client {clientId}.
        slots:
          linkIds: query.linkIds
          clickProfileId: path.clickProfileId
          clientId: path.clientId
      - text: Detach link ids {linkIds} from click profile {clickProfileId} in client {clientId}.
        slots:
          linkIds: query.linkIds
          clickProfileId: path.clickProfileId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/clickprofiles/{clickProfileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one click profile's details
      effect: read
      questions:
      - What name, description and rule pattern does a specific click profile have?
      - Can I look up a single click profile by its id?
      instructions:
      - text: Get click profile {clickProfileId} for client {clientId}.
        slots:
          clickProfileId: path.clickProfileId
          clientId: path.clientId
      - text: Show the rule details of click profile {clickProfileId} in client {clientId}.
        slots:
          clickProfileId: path.clickProfileId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/clickprofiles/{clickProfileId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a click profile
      effect: write
      questions:
      - Can I rename an existing click profile or change its description?
      - Is it possible to change the rule pattern on a click profile I already made?
      instructions:
      - text: Rename click profile {clickProfileId} in client {clientId} to {name}.
        slots:
          clickProfileId: path.clickProfileId
          clientId: path.clientId
          name: requestBody.name
      - text: 'Update click profile {clickProfileId} for client {clientId}: name {name}, description {description}.'
        slots:
          clickProfileId: path.clickProfileId
          clientId: path.clientId
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'