Microsoft Dynamics 365 Sales · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Dataverse Web API (Dynamics 365 Sales) Leads API

6 actions 6 updates phrasing extends openapi/microsoft-dynamics-365-sales-leads-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Microsoft Dynamics 365 Sales's API. It is a proposal applied on top of the contract, not a document Microsoft Dynamics 365 Sales publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/leads'].get

$.paths['/leads'].post

$.paths['/leads({leadid})'].get

$.paths['/leads({leadid})'].delete

$.paths['/leads({leadid})'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Dataverse Web API (Dynamics 365 Sales) Leads API
  version: 1.0.0
extends: openapi/microsoft-dynamics-365-sales-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['/leads'].get
  update:
    x-apievangelist-phrasing:
      intent: Search and list leads
      effect: read
      questions:
      - How do I get a list of my sales leads from Dynamics 365?
      - Can I filter leads to only show certain ones and choose which fields come back?
      instructions:
      - text: List leads matching {filter}.
        slots:
          filter: query.$filter
      - text: Show all leads with only the fields {select}.
        slots:
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture a new lead
      effect: write
      questions:
      - How do I add a new prospect as a lead?
      - Can I create a lead record from a web form submission?
      instructions:
      - text: Create a new lead.
      - text: Add this prospect as a lead in the CRM.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads({leadid})'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single lead by ID
      effect: read
      questions:
      - Where can I see the full record for one lead?
      - What information is stored on a particular lead?
      instructions:
      - text: Get lead {leadid}.
        slots:
          leadid: path.leadid
      - text: Show me the details for lead {leadid}.
        slots:
          leadid: path.leadid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads({leadid})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lead
      effect: destructive
      questions:
      - How do I permanently remove a lead?
      - Can I delete a junk or spam lead?
      instructions:
      - text: Delete lead {leadid}.
        slots:
          leadid: path.leadid
      - text: Remove the spam lead {leadid}.
        slots:
          leadid: path.leadid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/leads({leadid})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing lead
      effect: write
      questions:
      - What's the way to correct details on a lead that already exists?
      - Can I edit a lead's record after capturing it?
      instructions:
      - text: Update lead {leadid} with the new details.
        slots:
          leadid: path.leadid
      - text: Edit the existing lead {leadid}.
        slots:
          leadid: path.leadid
      method: generated
      generated: '2026-09-26'