# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Message Targets API
  version: 1.0.0
extends: openapi/optimizely-message-targets-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: 9
- target: $.paths['/api/v1/admin/MessageTargets'].get
  update:
    x-apievangelist-phrasing:
      intent: List message targets
      effect: read
      questions:
      - Who are site messages targeted at, across all messages?
      - Can I filter message targets to one message or target type?
      instructions:
      - text: List all message targets.
      - text: List message targets matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageTargets'].post
  update:
    x-apievangelist-phrasing:
      intent: Target a message at an audience
      effect: write
      questions:
      - How do I aim a storefront message at a specific customer or role?
      - What target type and key does a new message target need?
      instructions:
      - text: Target message {messageId} at {targetType} {targetKey}.
        slots:
          messageId: requestBody.messageId
          targetType: requestBody.targetType
          targetKey: requestBody.targetKey
      - text: Add a message target of type {targetType} with key {targetKey}.
        slots:
          targetType: requestBody.targetType
          targetKey: requestBody.targetKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageTargets({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a message target
      effect: read
      questions:
      - Can I look up one message target by ID?
      - Which message does a given target record belong to?
      instructions:
      - text: Show message target {id}.
        slots:
          id: path.id
      - text: Get message target {id} returning only {select}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageTargets({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a message target
      effect: write
      questions:
      - Can I overwrite a message target with a new audience?
      - What's the full-replace call for a message target?
      instructions:
      - text: Replace message target {id} with {targetType} {targetKey}.
        slots:
          id: path.id
          targetType: requestBody.targetType
          targetKey: requestBody.targetKey
      - text: Overwrite message target {id} for message {messageId}.
        slots:
          id: path.id
          messageId: requestBody.messageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageTargets({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a message target
      effect: destructive
      questions:
      - How do I stop a message going to one audience?
      - Can I delete a message target conditionally on its ETag?
      instructions:
      - text: Delete message target {id}.
        slots:
          id: path.id
      - text: Delete message target {id} if its ETag equals {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageTargets({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a message target
      effect: write
      questions:
      - Can I change only the target key on a message target?
      - Is there a partial update for who a message is aimed at?
      instructions:
      - text: Set message target {id} key to {targetKey}.
        slots:
          id: path.id
          targetKey: requestBody.targetKey
      - text: Patch message target {id} to type {targetType}.
        slots:
          id: path.id
          targetType: requestBody.targetType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/MessageTargets/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a message target
      effect: read
      questions:
      - What defaults are pre-filled for a new message target?
      - Is there a blank message target template?
      instructions:
      - text: Get the default message target template.
      - text: Show pre-filled values for a new message target.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/messagetargets/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several message targets
      effect: destructive
      questions:
      - Can I bulk delete message targets in one request?
      - Which call removes many message targets by ID?
      instructions:
      - text: Bulk delete message targets {ids}.
        slots:
          ids: query.ids
      - text: Remove the message targets {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/messagetargets({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a message target
      effect: read
      questions:
      - Can I read a custom field stored on a message target?
      - Where are extra attributes of a message target kept?
      instructions:
      - text: Get custom property {custompropertyKey} on message target {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show message target {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'