# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Coupon List API 🏷️ Coupon Lists API
  version: 1.0.0
extends: openapi/moengage-coupon-lists-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['/coupon-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List coupon lists in a workspace
      effect: read
      questions:
      - What coupon lists exist in my MoEngage workspace?
      - Can I see archived coupon lists, not just the active ones?
      instructions:
      - text: List all active coupon lists.
      - text: List coupon lists with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/coupon-list'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a coupon list
      effect: write
      questions:
      - How do I create a list of single-use coupon codes for campaigns?
      - Can I get emailed alerts when a new coupon list runs low?
      - What expiry and label does a new coupon list need?
      instructions:
      - text: Create a coupon list {name} labeled {label} expiring {expires_at}, created by {created_by}.
        slots:
          name: requestBody.name
          label: requestBody.label
          expires_at: requestBody.expires_at
          created_by: requestBody.created_by
      - text: Make a new coupon list {name} that alerts {email_alert_subscribers} when stock is low.
        slots:
          name: requestBody.name
          email_alert_subscribers: requestBody.email_alert_subscribers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/coupon-list/{coupon_list_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a coupon list's details and counts
      effect: read
      questions:
      - How many coupons are still available in a specific coupon list?
      - What are the expiry date and alert settings on one coupon list?
      instructions:
      - text: Get the details of coupon list {coupon_list_id}.
        slots:
          coupon_list_id: path.coupon_list_id
      - text: Show how many codes remain in {coupon_list_id}.
        slots:
          coupon_list_id: path.coupon_list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/coupon-list/{coupon_list_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a coupon list's settings
      effect: write
      questions:
      - Can I rename a coupon list or push back its expiry date?
      - How do I change who gets low-stock alerts for a coupon list?
      instructions:
      - text: Change the expiry of coupon list {coupon_list_id} to {expires_at}.
        slots:
          coupon_list_id: path.coupon_list_id
          expires_at: requestBody.expires_at
      - text: Rename coupon list {coupon_list_id} to {name}.
        slots:
          coupon_list_id: path.coupon_list_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/coupon-list/{coupon_list_id}/activate'].put
  update:
    x-apievangelist-phrasing:
      intent: Reactivate an archived coupon list
      effect: write
      questions:
      - How do I bring an archived coupon list back into use?
      - Does reactivating a coupon list require a new future expiry date?
      instructions:
      - text: Reactivate archived coupon list {coupon_list_id} with expiry {expires_at}.
        slots:
          coupon_list_id: path.coupon_list_id
          expires_at: requestBody.expires_at
      - text: Unarchive {coupon_list_id} and make it active until {expires_at}.
        slots:
          coupon_list_id: path.coupon_list_id
          expires_at: requestBody.expires_at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/coupon-list/{coupon_list_id}/archive'].put
  update:
    x-apievangelist-phrasing:
      intent: Archive a coupon list
      effect: destructive
      questions:
      - What happens to the coupon codes when I archive a coupon list?
      - How do I retire an active coupon list so campaigns stop drawing from it?
      instructions:
      - text: Archive coupon list {coupon_list_id}.
        slots:
          coupon_list_id: path.coupon_list_id
      - text: Retire {coupon_list_id} and delete its remaining codes.
        slots:
          coupon_list_id: path.coupon_list_id
      method: generated
      generated: '2026-10-01'