# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Iterable Subscriptions API
  version: 1.0.0
extends: openapi/iterable-subscriptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/api/subscriptions/subscribeToDoubleOptIn'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a double opt-in subscription
      effect: write
      questions:
      - How do I send a double opt-in confirmation before subscribing someone?
      - Can double opt-in work by phone number for SMS message types?
      instructions:
      - text: Start double opt-in for {email} to message types {messageTypeIds}.
        slots:
          email: requestBody.email
          messageTypeIds: requestBody.messageTypeIds
      - text: Send a double opt-in request to {phoneNumber} for message types {messageTypeIds}.
        slots:
          phoneNumber: requestBody.phoneNumber
          messageTypeIds: requestBody.messageTypeIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Subscribe or unsubscribe many users to a group
      effect: write
      questions:
      - Can I subscribe a batch of users to a subscription group in one call?
      - Is bulk unsubscribing by userId supported for a message type or list?
      instructions:
      - text: Run {action} on {subscriptionGroup} {subscriptionGroupId} for users {users}.
        slots:
          action: query.action
          subscriptionGroup: path.subscriptionGroup
          subscriptionGroupId: path.subscriptionGroupId
          users: requestBody.users
      - text: Bulk {action} user IDs {usersByUserId} for {subscriptionGroup} {subscriptionGroupId}.
        slots:
          action: query.action
          usersByUserId: requestBody.usersByUserId
          subscriptionGroup: path.subscriptionGroup
          subscriptionGroupId: path.subscriptionGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}/byUserId/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe one user by userId
      effect: destructive
      questions:
      - Can I unsubscribe a single userId from a subscription group?
      - Does the per-user unsubscribe by ID need to be enabled first?
      instructions:
      - text: Unsubscribe user ID {userId} from {subscriptionGroup} {subscriptionGroupId}.
        slots:
          userId: path.userId
          subscriptionGroup: path.subscriptionGroup
          subscriptionGroupId: path.subscriptionGroupId
      - text: Remove user {userId} from subscription group {subscriptionGroup} {subscriptionGroupId}.
        slots:
          userId: path.userId
          subscriptionGroup: path.subscriptionGroup
          subscriptionGroupId: path.subscriptionGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}/byUserId/{userId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Subscribe one user by userId
      effect: write
      questions:
      - How do I subscribe one userId to a message type or list?
      - Can a single user be opted in by userId rather than email?
      instructions:
      - text: Subscribe user ID {userId} to {subscriptionGroup} {subscriptionGroupId}.
        slots:
          userId: path.userId
          subscriptionGroup: path.subscriptionGroup
          subscriptionGroupId: path.subscriptionGroupId
      - text: Opt user {userId} into subscription group {subscriptionGroup} {subscriptionGroupId}.
        slots:
          userId: path.userId
          subscriptionGroup: path.subscriptionGroup
          subscriptionGroupId: path.subscriptionGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}/user/{userEmail}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe one user by email
      effect: destructive
      questions:
      - Can I unsubscribe one email address from a subscription group?
      - What's needed to opt a single email out of a message type?
      instructions:
      - text: Unsubscribe {userEmail} from {subscriptionGroup} {subscriptionGroupId}.
        slots:
          userEmail: path.userEmail
          subscriptionGroup: path.subscriptionGroup
          subscriptionGroupId: path.subscriptionGroupId
      - text: Opt email {userEmail} out of subscription group {subscriptionGroup} {subscriptionGroupId}.
        slots:
          userEmail: path.userEmail
          subscriptionGroup: path.subscriptionGroup
          subscriptionGroupId: path.subscriptionGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscriptions/{subscriptionGroup}/{subscriptionGroupId}/user/{userEmail}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Subscribe one user by email
      effect: write
      questions:
      - How do I subscribe one email address to a list or message type?
      - Can a single email be opted into a subscription group?
      instructions:
      - text: Subscribe {userEmail} to {subscriptionGroup} {subscriptionGroupId}.
        slots:
          userEmail: path.userEmail
          subscriptionGroup: path.subscriptionGroup
          subscriptionGroupId: path.subscriptionGroupId
      - text: Opt email {userEmail} into subscription group {subscriptionGroup} {subscriptionGroupId}.
        slots:
          userEmail: path.userEmail
          subscriptionGroup: path.subscriptionGroup
          subscriptionGroupId: path.subscriptionGroupId
      method: generated
      generated: '2026-10-01'