Microsoft Dynamics 365 Sales · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/microsoft-dynamics-365-sales-opportunities-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['/opportunities'].get

$.paths['/opportunities'].post

$.paths['/opportunities({opportunityid})'].get

$.paths['/opportunities({opportunityid})'].delete

$.paths['/opportunities({opportunityid})'].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)…
  version: 1.0.0
extends: openapi/microsoft-dynamics-365-sales-opportunities-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['/opportunities'].get
  update:
    x-apievangelist-phrasing:
      intent: List sales opportunities
      effect: read
      questions:
      - How do I see all the deals in my Dynamics 365 Sales pipeline?
      - Can I pull every open opportunity through the API?
      instructions:
      - text: List all opportunities.
      - text: Show me every deal in the pipeline.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/opportunities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sales opportunity
      effect: write
      questions:
      - How do I add a new deal to the pipeline?
      - Can I create an opportunity record through the API?
      instructions:
      - text: Create a new opportunity.
      - text: Add a new deal to the sales pipeline.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/opportunities({opportunityid})'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single opportunity by ID
      effect: read
      questions:
      - Where can I see the full record for one deal?
      - What details are stored on a specific opportunity?
      instructions:
      - text: Get opportunity {opportunityid}.
        slots:
          opportunityid: path.opportunityid
      - text: Show me the deal {opportunityid}.
        slots:
          opportunityid: path.opportunityid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/opportunities({opportunityid})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an opportunity
      effect: destructive
      questions:
      - How do I permanently remove a deal from the pipeline?
      - Can I delete an opportunity that was created by mistake?
      instructions:
      - text: Delete opportunity {opportunityid}.
        slots:
          opportunityid: path.opportunityid
      - text: Remove the mistaken deal {opportunityid} from the pipeline.
        slots:
          opportunityid: path.opportunityid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/opportunities({opportunityid})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing opportunity
      effect: write
      questions:
      - What's the way to correct details on a deal already in the pipeline?
      - Can I edit an existing opportunity record?
      instructions:
      - text: Update opportunity {opportunityid} with the new details.
        slots:
          opportunityid: path.opportunityid
      - text: Edit the existing deal {opportunityid}.
        slots:
          opportunityid: path.opportunityid
      method: generated
      generated: '2026-09-26'