Microsoft Dynamics 365 Sales · OpenAPI Overlay 1.0.0

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

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

$.paths['/contacts'].post

$.paths['/contacts({contactid})'].get

$.paths['/contacts({contactid})'].delete

$.paths['/contacts({contactid})'].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) Contacts…
  version: 1.0.0
extends: openapi/microsoft-dynamics-365-sales-contacts-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['/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: Search and list contacts
      effect: read
      questions:
      - How do I get a list of the people in my CRM contacts?
      - Can I filter contacts by last name or email and limit how many come back?
      instructions:
      - text: List contacts matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} contacts with only {select}.
        slots:
          top: query.$top
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new contact
      effect: write
      questions:
      - How do I add a new person as a contact in Dynamics 365 Sales?
      - Can I create a contact record through the API?
      instructions:
      - text: Create a new contact in the CRM.
      - text: Add this person as a new contact record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts({contactid})'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single contact by ID
      effect: read
      questions:
      - Where can I see everything stored on one contact?
      - What does a specific contact record contain?
      instructions:
      - text: Get contact {contactid}.
        slots:
          contactid: path.contactid
      - text: Show me the details for contact {contactid}.
        slots:
          contactid: path.contactid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts({contactid})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact
      effect: destructive
      questions:
      - How do I permanently remove a contact from the CRM?
      - Can I delete a contact who asked to be removed?
      instructions:
      - text: Delete contact {contactid}.
        slots:
          contactid: path.contactid
      - text: Remove contact {contactid} from Dynamics.
        slots:
          contactid: path.contactid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contacts({contactid})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing contact
      effect: write
      questions:
      - What's the way to correct details on a contact that already exists?
      - Can I edit a contact's record after it has been created?
      instructions:
      - text: Update contact {contactid} with the new details.
        slots:
          contactid: path.contactid
      - text: Edit the existing contact {contactid}.
        slots:
          contactid: path.contactid
      method: generated
      generated: '2026-09-26'