Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CRM Subpackage Leads API

6 actions 6 updates phrasing extends openapi/merge-subpackage-leads-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 6

$.info
$.paths['/crm/v1/leads'].get
$.paths['/crm/v1/leads'].post
$.paths['/crm/v1/leads/{id}'].get
$.paths['/crm/v1/leads/meta/post'].get
$.paths['/crm/v1/leads/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 Leads API
  version: 1.0.0
extends: openapi/merge-subpackage-leads-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: 5
- target: $.paths['/crm/v1/leads'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM leads
      effect: read
      questions:
      - Can I pull all leads owned by a particular sales rep from a customer's CRM?
      - Which leads were converted into a given account or contact?
      - Can I look up a lead by email address or phone number?
      instructions:
      - text: List leads owned by {owner_id}.
        slots:
          owner_id: query.owner_id
      - text: Find leads with email {email_addresses}.
        slots:
          email_addresses: query.email_addresses
      - text: Show leads converted to account {converted_account_id}.
        slots:
          converted_account_id: query.converted_account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/leads'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a CRM lead
      effect: write
      questions:
      - How do I add a new lead to a customer's CRM?
      - Can lead creation be queued to run asynchronously?
      instructions:
      - text: Create lead {model} in linked account {account_token}.
        slots:
          model: requestBody.model
          account_token: header.X-Account-Token
      - text: Add a new sales lead with {model}.
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/leads/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CRM lead
      effect: read
      questions:
      - What company, source and owner are recorded on one lead?
      - Can I include custom remote fields when fetching a single lead?
      instructions:
      - text: Get lead {id}.
        slots:
          id: path.id
      - text: Fetch lead {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/leads/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields for creating leads
      effect: read
      questions:
      - Which fields does a CRM integration require when creating a lead?
      - What can I set on a new lead for a given CRM?
      instructions:
      - text: Show lead POST metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Describe the create fields for new leads.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/leads/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for leads
      effect: read
      questions:
      - What custom fields are defined on leads in a customer's CRM?
      - Can I list only the non-standard lead field classes?
      instructions:
      - text: List lead remote field classes for account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show lead field classes where custom is {is_custom}.
        slots:
          is_custom: query.is_custom
      method: generated
      generated: '2026-09-26'