MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Coupon List API 🏷️ Coupon Files API

5 actions 5 updates phrasing extends openapi/moengage-coupon-files-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for MoEngage's API. It is a proposal applied on top of the contract, not a document MoEngage publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/coupon-list/{coupon_list_id}/files'].get
$.paths['/coupon-list/{coupon_list_id}/files'].post
$.paths['/coupon-list/{coupon_list_id}/files/{coupon_file_id}'].get
$.paths['/coupon-list/{coupon_list_id}/files/{coupon_file_id}'].delete

OpenAPI Overlay

Raw ↑ 
# 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 Files API
  version: 1.0.0
extends: openapi/moengage-coupon-files-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: 4
- target: $.paths['/coupon-list/{coupon_list_id}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List the files in a coupon list
      effect: read
      questions:
      - How do I see every file that was uploaded into a coupon list?
      - How many coupons did each file add to my coupon list, and when?
      instructions:
      - text: List all coupon files in coupon list {coupon_list_id}.
        slots:
          coupon_list_id: path.coupon_list_id
      - text: Show the status of every file uploaded to {coupon_list_id}.
        slots:
          coupon_list_id: path.coupon_list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/coupon-list/{coupon_list_id}/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload coupon codes into a coupon list
      effect: write
      questions:
      - How do I replenish a coupon list that's running low on codes?
      - Can I load coupons from a password-protected file URL?
      - Can I get a callback when my coupon file finishes processing?
      instructions:
      - text: Upload the coupon file at {file_url} to coupon list {coupon_list_id}.
        slots:
          file_url: requestBody.file_url
          coupon_list_id: path.coupon_list_id
      - text: Add coupons from {file_url} to {coupon_list_id} and notify {callback_url} when done.
        slots:
          file_url: requestBody.file_url
          coupon_list_id: path.coupon_list_id
          callback_url: requestBody.callback_url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/coupon-list/{coupon_list_id}/files/{coupon_file_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one coupon file's status
      effect: read
      questions:
      - What's the processing status of a single coupon file I uploaded?
      - How many coupons were added from one particular file?
      instructions:
      - text: Get coupon file {coupon_file_id} from coupon list {coupon_list_id}.
        slots:
          coupon_file_id: path.coupon_file_id
          coupon_list_id: path.coupon_list_id
      - text: Check how many codes file {coupon_file_id} added to {coupon_list_id}.
        slots:
          coupon_file_id: path.coupon_file_id
          coupon_list_id: path.coupon_list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/coupon-list/{coupon_list_id}/files/{coupon_file_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a coupon file from a coupon list
      effect: destructive
      questions:
      - How do I remove a test file I uploaded to a coupon list by mistake?
      - Can I delete just one file's coupons without touching the rest of the list?
      instructions:
      - text: Delete coupon file {coupon_file_id} from coupon list {coupon_list_id}.
        slots:
          coupon_file_id: path.coupon_file_id
          coupon_list_id: path.coupon_list_id
      - text: Remove the wrongly uploaded file {coupon_file_id} from {coupon_list_id}.
        slots:
          coupon_file_id: path.coupon_file_id
          coupon_list_id: path.coupon_list_id
      method: generated
      generated: '2026-10-01'