MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Cards API

3 actions 3 updates phrasing extends openapi/moengage-cards-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 3

$.info

$.paths['/cards/fetch'].post

$.paths['/cards/delete'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for MoEngage Cards API
  version: 1.0.0
extends: openapi/moengage-cards-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: 2
- target: $.paths['/cards/fetch'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch a user's active cards
      effect: read
      questions:
      - How do I get all the active cards a specific user should see in their inbox?
      - Can I filter a user's cards by platform or card category?
      - Which cards were updated for a user since their last sync?
      instructions:
      - text: Fetch the active cards for user {uid}.
        slots:
          uid: requestBody.uid
      - text: Get cards for user {uid} on {platforms} in category {card_category}.
        slots:
          uid: requestBody.uid
          platforms: requestBody.platforms
          card_category: requestBody.card_category
      - text: Show cards updated for {uid} since {last_updated_time}.
        slots:
          uid: requestBody.uid
          last_updated_time: requestBody.last_updated_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cards/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's cards from campaigns
      effect: destructive
      questions:
      - How do I remove cards from a user's inbox for specific campaigns?
      - Can I delete a user's cards on just one platform?
      instructions:
      - text: Delete the cards from campaigns {campaign_ids} for user {uid}.
        slots:
          campaign_ids: requestBody.campaign_ids
          uid: requestBody.uid
      - text: Remove cards of campaigns {campaign_ids} for {uid} on {platforms} only.
        slots:
          campaign_ids: requestBody.campaign_ids
          uid: requestBody.uid
          platforms: requestBody.platforms
      method: generated
      generated: '2026-10-01'