Microsoft Dynamics 365 Sales · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/microsoft-dynamics-365-sales-accounts-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['/accounts'].get
$.paths['/accounts'].post
$.paths['/accounts({accountid})'].get
$.paths['/accounts({accountid})'].delete
$.paths['/accounts({accountid})'].patch

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 Microsoft Dataverse Web API (Dynamics 365 Sales) Accounts…
  version: 1.0.0
extends: openapi/microsoft-dynamics-365-sales-accounts-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['/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Search and list customer accounts
      effect: read
      questions:
      - How can I pull a list of all my customer accounts from Dynamics 365 Sales?
      - Can I filter accounts by city or country and sort them by revenue?
      - Which accounts are currently on credit hold?
      instructions:
      - text: List accounts matching {filter}, sorted by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      - text: Show the top {top} accounts with only the fields {select}.
        slots:
          top: query.$top
          select: query.$select
      - text: List accounts and include their primary contact via {expand}.
        slots:
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new customer account
      effect: write
      questions:
      - How do I add a new company account to my CRM?
      - Can I link a new account to an existing contact as its primary contact when creating it?
      - What details can I set when I first create an account, like revenue or website?
      instructions:
      - text: Create a new account named {name} with website {websiteurl}.
        slots:
          name: requestBody.name
          websiteurl: requestBody.websiteurl
      - text: Add a new account {name} located in {city}, {country}.
        slots:
          name: requestBody.name
          city: requestBody.address1_city
          country: requestBody.address1_country
      - text: Create account {name} and return the created record.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts({accountid})'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single account by ID
      effect: read
      questions:
      - How do I fetch the full details of one specific account?
      - Can I retrieve just a few fields of an account record by its ID?
      instructions:
      - text: Get account {accountid}.
        slots:
          accountid: path.accountid
      - text: Show fields {select} for account {accountid}.
        slots:
          select: query.$select
          accountid: path.accountid
      - text: Fetch account {accountid} with related records {expand} expanded.
        slots:
          accountid: path.accountid
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts({accountid})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account
      effect: destructive
      questions:
      - How do I permanently remove an account from the CRM?
      - Is there a way to delete a duplicate account record?
      instructions:
      - text: Delete account {accountid}.
        slots:
          accountid: path.accountid
      - text: Remove the duplicate account {accountid} from Dynamics.
        slots:
          accountid: path.accountid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts({accountid})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing account
      effect: write
      questions:
      - How do I change the phone number or address on an existing account?
      - Can I put an existing account on credit hold?
      - Can I make an account update only succeed if the record hasn't changed since I read it?
      instructions:
      - text: Update account {accountid} to have phone number {telephone1}.
        slots:
          accountid: path.accountid
          telephone1: requestBody.telephone1
      - text: Set credit hold to {creditonhold} on account {accountid}.
        slots:
          creditonhold: requestBody.creditonhold
          accountid: path.accountid
      - text: Rename account {accountid} to {name} only if its ETag still matches {etag}.
        slots:
          accountid: path.accountid
          name: requestBody.name
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'