MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Segments Manage Segments API

3 actions 3 updates phrasing extends openapi/moengage-manage-segments-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['/v2/custom-segments/archive'].patch
$.paths['/v2/custom-segments/unarchive'].patch

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 MoEngage Segments Manage Segments API
  version: 1.0.0
extends: openapi/moengage-manage-segments-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['/v2/custom-segments/archive'].patch
  update:
    x-apievangelist-phrasing:
      intent: Archive a segment
      effect: write
      questions:
      - How do I archive a segment I'm not using right now?
      - Can I archive a segment and bring it back later?
      instructions:
      - text: Archive segment {name}.
        slots:
          name: requestBody.name
      - text: Archive segment {name} with ID {cs_id}.
        slots:
          name: requestBody.name
          cs_id: requestBody.cs_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/custom-segments/unarchive'].patch
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived segment
      effect: write
      questions:
      - How do I make an archived segment active again?
      - Can I unarchive a segment by its ID?
      instructions:
      - text: Unarchive segment {name}.
        slots:
          name: requestBody.name
      - text: Restore archived segment {name} with ID {cs_id}.
        slots:
          name: requestBody.name
          cs_id: requestBody.cs_id
      method: generated
      generated: '2026-10-01'