MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Data Device API

3 actions 3 updates phrasing extends openapi/moengage-device-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['/device/{app_id}'].post
$.paths['/devices/manage'].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 Device API
  version: 1.0.0
extends: openapi/moengage-device-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['/device/{app_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or update a user's device properties
      effect: write
      questions:
      - How do I register a new device for an existing user?
      - Can I update the properties stored on a user's device?
      - What do I need to send to track a device for a customer?
      instructions:
      - text: Track device {device_id} for customer {customer_id} in workspace {app_id}.
        slots:
          device_id: requestBody.device_id
          customer_id: requestBody.customer_id
          app_id: path.app_id
      - text: Set device properties {attributes} on device {device_id} of customer {customer_id}.
        slots:
          attributes: requestBody.attributes
          device_id: requestBody.device_id
          customer_id: requestBody.customer_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/manage'].post
  update:
    x-apievangelist-phrasing:
      intent: Block or unblock a device from push notifications
      effect: write
      questions:
      - How do I stop push notifications reaching a stolen phone?
      - Can I unblock a device once it has been recovered?
      - Is it possible to block every device belonging to one user from receiving pushes?
      instructions:
      - text: Block push notifications to the devices of user {user_identifier_value} in workspace {app_id}.
        slots:
          user_identifier_value: requestBody.user_identifier_value
          app_id: query.app_id
      - text: Apply {action_type} to devices {device_identifiers} of user {user_identifier_value} because {reason}.
        slots:
          action_type: requestBody.action_type
          device_identifiers: requestBody.device_identifiers
          user_identifier_value: requestBody.user_identifier_value
          reason: requestBody.reason
      method: generated
      generated: '2026-10-01'