Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CRM Subpackage Engagement Types API

4 actions 4 updates phrasing extends openapi/merge-subpackage-engagementtypes-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Merge's API. It is a proposal applied on top of the contract, not a document Merge publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/crm/v1/engagement-types'].get
$.paths['/crm/v1/engagement-types/{id}'].get
$.paths['/crm/v1/engagement-types/remote-field-classes'].get

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 CRM Subpackage Engagement Types API
  version: 1.0.0
extends: openapi/merge-subpackage-engagementtypes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/crm/v1/engagement-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM engagement types
      effect: read
      questions:
      - What kinds of engagements, like calls, emails or meetings, does a customer's CRM track?
      - Can I list engagement types modified since a date?
      instructions:
      - text: List CRM engagement types for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show engagement types changed after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/engagement-types/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one CRM engagement type
      effect: read
      questions:
      - How do I read a single engagement type from the CRM?
      - Can I include custom fields on one engagement type?
      instructions:
      - text: Get engagement type {id}.
        slots:
          id: path.id
      - text: Fetch CRM engagement type {id} with remote fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/engagement-types/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for engagement types
      effect: read
      questions:
      - Which custom fields are defined on CRM engagement types?
      - Can I list only the custom engagement type field classes?
      instructions:
      - text: List engagement type remote field classes for {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show custom field definitions on engagement types.
      method: generated
      generated: '2026-09-26'