MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Segments File Segments API

5 actions 5 updates phrasing extends openapi/moengage-file-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 5

$.info
$.paths['/v2/custom-segments/file-segment'].post
$.paths['/v2/custom-segments/file-segment/add-users'].put
$.paths['/v2/custom-segments/file-segment/remove-users'].put
$.paths['/v2/custom-segments/file-segment/replace'].put

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 File Segments API
  version: 1.0.0
extends: openapi/moengage-file-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: 4
- target: $.paths['/v2/custom-segments/file-segment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a segment from a CSV file
      effect: write
      questions:
      - How do I build a user segment from a CSV file of user IDs?
      - Can a file segment expire automatically?
      - Can I get an email or callback when my file segment finishes processing?
      instructions:
      - text: Create file segment {name} from {file_url} matching on {attribute_name} ({attribute_type}), expiring {expiry_time}.
        slots:
          name: requestBody.name
          file_url: requestBody.file_url
          attribute_name: requestBody.attribute_name
          attribute_type: requestBody.attribute_type
          expiry_time: requestBody.expiry_time
      - text: Make a new segment {name} from the CSV at {file_url}, keyed on {attribute_name} as {attribute_type}, expiring {expiry_time}.
        slots:
          name: requestBody.name
          file_url: requestBody.file_url
          attribute_name: requestBody.attribute_name
          attribute_type: requestBody.attribute_type
          expiry_time: requestBody.expiry_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/custom-segments/file-segment/add-users'].put
  update:
    x-apievangelist-phrasing:
      intent: Add users from a CSV to a file segment
      effect: write
      questions:
      - How do I append more users to an existing file segment?
      - Can I add users to a file segment without replacing the ones already in it?
      instructions:
      - text: Add the users in {file_url} to file segment {name}, matched on {attribute_name} ({attribute_type}).
        slots:
          file_url: requestBody.file_url
          name: requestBody.name
          attribute_name: requestBody.attribute_name
          attribute_type: requestBody.attribute_type
      - text: Append users from CSV {file_url} to segment {cs_id} by {attribute_name} of type {attribute_type}, name {name}.
        slots:
          file_url: requestBody.file_url
          cs_id: requestBody.cs_id
          attribute_name: requestBody.attribute_name
          attribute_type: requestBody.attribute_type
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/custom-segments/file-segment/remove-users'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove users listed in a CSV from a file segment
      effect: write
      questions:
      - How do I take specific users out of a file segment using a CSV?
      - Can I drop some users from a file segment and keep everyone else?
      instructions:
      - text: Remove the users in {file_url} from file segment {name}, matched on {attribute_name} ({attribute_type}).
        slots:
          file_url: requestBody.file_url
          name: requestBody.name
          attribute_name: requestBody.attribute_name
          attribute_type: requestBody.attribute_type
      - text: Drop users from CSV {file_url} out of segment {cs_id} by {attribute_name} as {attribute_type}, name {name}.
        slots:
          file_url: requestBody.file_url
          cs_id: requestBody.cs_id
          attribute_name: requestBody.attribute_name
          attribute_type: requestBody.attribute_type
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/custom-segments/file-segment/replace'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all users in a file segment
      effect: write
      questions:
      - How do I swap out a file segment's entire membership with a fresh CSV?
      - Can I overwrite everyone in a file segment instead of adding to it?
      instructions:
      - text: Replace everyone in file segment {name} with the users in {file_url}, matched on {attribute_name} ({attribute_type}).
        slots:
          name: requestBody.name
          file_url: requestBody.file_url
          attribute_name: requestBody.attribute_name
          attribute_type: requestBody.attribute_type
      - text: Overwrite segment {cs_id} membership with CSV {file_url} keyed on {attribute_name} as {attribute_type}, name {name}.
        slots:
          cs_id: requestBody.cs_id
          file_url: requestBody.file_url
          attribute_name: requestBody.attribute_name
          attribute_type: requestBody.attribute_type
          name: requestBody.name
      method: generated
      generated: '2026-10-01'