Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V1 Resource Contact API

17 actions 17 updates phrasing extends openapi/deputy-contact-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Deputy's API. It is a proposal applied on top of the contract, not a document Deputy publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 17 · first 16 shown; the file carries all of them

$.info
$.paths['/resource/Contact'].get
$.paths['/resource/Contact'].put
$.paths['/resource/Contact'].post
$.paths['/resource/Contact/BULK'].post
$.paths['/resource/Contact/INFO'].get
$.paths['/resource/Contact/PREDICT'].post
$.paths['/resource/Contact/QUERY'].post
$.paths['/resource/Contact/{id}'].get
$.paths['/resource/Contact/{id}'].put
$.paths['/resource/Contact/{id}'].post
$.paths['/resource/Contact/{id}'].delete
$.paths['/resource/Contact/{id}/COMMENTS'].get
$.paths['/resource/Contact/{id}/COMMENTS'].post
$.paths['/resource/Contact/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Contact/{id}/HISTORY'].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 Deputy V1 Resource Contact API
  version: 1.0.0
extends: openapi/deputy-contact-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-17'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 16
- target: $.paths['/resource/Contact'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact records
      effect: read
      questions:
      - Which contact records can I see in Deputy?
      - Can I page through the contact list?
      instructions:
      - text: List all my contact records.
      - text: Show every contact record I have access to.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a contact record
      effect: write
      questions:
      - How do I create a contact record with a known ID?
      - Can I overwrite an existing contact record by ID?
      instructions:
      - text: Create contact {id} with ID {id}.
        slots:
          id: requestBody.Id
      - text: Replace contact {id} with a new record.
        slots:
          id: requestBody.Id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contact record
      effect: write
      questions:
      - How do I add a new contact record?
      - Can I create a contact without an ID?
      instructions:
      - text: Create a new contact record.
      - text: Add a contact with ID {id}.
        slots:
          id: requestBody.Id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many contacts at once
      effect: write
      questions:
      - Can I create or update several contacts in one request?
      - How do I bulk upsert contact records?
      instructions:
      - text: Bulk create or update these contact records.
      - text: Upsert this batch of contacts.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get contact field metadata
      effect: read
      questions:
      - Which fields can I query on contact records?
      - What field types and associations does the contact resource have?
      instructions:
      - text: Show the field metadata for contact records.
      - text: List the queryable fields on contacts.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find a matching contact for a partial record
      effect: read
      questions:
      - Can I find an existing contact before creating a duplicate?
      - Which existing contact record matches this partial payload?
      instructions:
      - text: Predict-match a contact for {id}.
        slots:
          id: requestBody.Id
      - text: Find the existing contact that matches this partial record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search contact records
      effect: read
      questions:
      - How do I search contacts by name or phone number?
      - Can I sort and page through contact search results?
      instructions:
      - text: Search contacts matching {search}.
        slots:
          search: requestBody.search
      - text: Find contacts matching {search}, sorted by {sort}.
        slots:
          search: requestBody.search
          sort: requestBody.sort
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact record
      effect: read
      questions:
      - How do I look up one contact by ID?
      - What details are stored on a single contact record?
      instructions:
      - text: Get contact {id}.
        slots:
          id: path.id
      - text: Show the details of contact {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contact's details
      effect: write
      questions:
      - How do I change a staff member's phone number in Deputy?
      - Can I set a primary phone or email when updating a contact?
      instructions:
      - text: Update contact {id} with phone {phone}.
        slots:
          id: path.id
          phone: requestBody.Phone1
      - text: Set {email} as the primary email for contact {id}.
        slots:
          email: requestBody.Email1
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a contact record
      effect: write
      questions:
      - How do I change a few fields on an existing contact?
      - Can I patch an existing contact record?
      instructions:
      - text: Update contact {id} with these changes.
        slots:
          id: path.id
      - text: Patch existing contact {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact record
      effect: destructive
      questions:
      - How do I delete a contact record?
      - Can I remove a contact from Deputy?
      instructions:
      - text: Delete contact {id}.
        slots:
          id: path.id
      - text: Remove the contact record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a contact
      effect: read
      questions:
      - What comments have been left on a contact?
      - Can I read the comment history on a contact?
      instructions:
      - text: List comments on contact {id}.
        slots:
          id: path.id
      - text: Show the comment history for contact {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a contact
      effect: write
      questions:
      - How do I add a comment to a contact?
      - Can I leave a note on a contact record?
      instructions:
      - text: Add comment {comment} to contact {id}.
        slots:
          comment: requestBody.Comment
          id: path.id
      - text: Leave a note on contact {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a contact
      effect: destructive
      questions:
      - How do I delete a comment from a contact?
      - Can I remove a comment on a contact record?
      instructions:
      - text: Delete comment {commentId} from contact {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove the comment {commentId} on contact {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change history for a contact
      effect: read
      questions:
      - What changes have been made to a contact over time?
      - Can I see the edit history of a contact?
      instructions:
      - text: Show the change history for contact {id}.
        slots:
          id: path.id
      - text: List every edit made to contact {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Contact/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact as it was at a past time
      effect: read
      questions:
      - Can I see what a contact looked like at a past moment?
      - How do I travel back to an earlier version of a contact?
      instructions:
      - text: Show contact {id} as it existed at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to contact {id} at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      method: generated
      generated: '2026-11-17'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-contact-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.