MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Data User API

5 actions 5 updates phrasing extends openapi/moengage-user-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['/customer/{app_id}'].post
$.paths['/customers/export'].post
$.paths['/customer/merge'].post
$.paths['/customer/delete'].post

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 Data User API
  version: 1.0.0
extends: openapi/moengage-user-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['/customer/{app_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a user profile
      effect: write
      questions:
      - How do I create a new user or update their profile attributes?
      - Can I update only users that already exist without creating new ones?
      - Which platforms can I record for a user profile?
      instructions:
      - text: Set attributes {attributes} on customer {customer_id} in workspace {app_id}.
        slots:
          attributes: requestBody.attributes
          customer_id: requestBody.customer_id
          app_id: path.app_id
      - text: Update existing customer {customer_id} only (update_existing_only {update_existing_only}).
        slots:
          customer_id: requestBody.customer_id
          update_existing_only: requestBody.update_existing_only
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up users by their IDs
      effect: read
      questions:
      - How do I fetch a user's profile details by their ID?
      - Can I retrieve several users' information in one request?
      instructions:
      - text: Get the profiles of users {data} from workspace {app_id}.
        slots:
          data: requestBody.data
          app_id: query.app_id
      - text: Look up user details for IDs {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer/merge'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge duplicate user profiles
      effect: destructive
      questions:
      - How do I combine two profiles that belong to the same person?
      - Can I merge a user who signed up once by email and once by phone?
      instructions:
      - text: Merge these duplicate user pairs {merge_data} in workspace {app_id}.
        slots:
          merge_data: requestBody.merge_data
          app_id: query.app_id
      - text: Combine the duplicate profiles created by an integration bug in workspace {app_id}.
        slots:
          app_id: query.app_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customer/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a user
      effect: destructive
      questions:
      - How do I permanently delete a user from MoEngage?
      - Is there a buffer period before a deleted user is actually removed?
      - Can I delete a user by their MoEngage ID instead of my own customer ID?
      instructions:
      - text: Delete user {identity_value} from workspace {app_id}.
        slots:
          identity_value: requestBody.identity_value
          app_id: query.app_id
      - text: Hard-delete the user whose {identity_type} is {identity_value}.
        slots:
          identity_type: requestBody.identity_type
          identity_value: requestBody.identity_value
      method: generated
      generated: '2026-10-01'