Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Location Profile API

6 actions 6 updates phrasing extends openapi/deputy-location-profile-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 6

$.info
$.paths['/management/v2/locations'].get
$.paths['/management/v2/locations/{id}'].get
$.paths['/management/v2/locations/{id}:unarchive'].post
$.paths['/management/v2/locations/{id}:update-address'].post
$.paths['/management/v2/locations/{id}:update-business-number'].post

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 V2 Location Profile API
  version: 1.0.0
extends: openapi/deputy-location-profile-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: 5
- target: $.paths['/management/v2/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List locations
      effect: read
      questions:
      - Which locations exist in Deputy?
      - Can I list only active locations or by parent location?
      instructions:
      - text: List locations matching {filters}.
        slots:
          filters: query.filters
      - text: Show {limit} locations ordered by {orderBy}.
        slots:
          limit: query.limit
          orderBy: query.orderBy
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/locations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a location
      effect: read
      questions:
      - How do I look up one location profile by ID?
      - What details come back for a single location?
      instructions:
      - text: Get location {id}.
        slots:
          id: path.id
      - text: Show the profile of location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/locations/{id}:unarchive'].post
  update:
    x-apievangelist-phrasing:
      intent: Unarchive a location
      effect: write
      questions:
      - How do I bring a soft-deleted location back?
      - Can I restore a location that was archived?
      instructions:
      - text: Unarchive location {id}.
        slots:
          id: path.id
      - text: Restore the archived location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/locations/{id}:update-address'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a location's address
      effect: write
      questions:
      - How do I change the address on a location?
      - Can I update a location's address by its ID?
      instructions:
      - text: Set the address of location {id} to {address}.
        slots:
          id: path.id
          address: requestBody.address
      - text: Update location {id} with address {address}.
        slots:
          id: path.id
          address: requestBody.address
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/locations/{id}:update-business-number'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a location's business number
      effect: write
      questions:
      - How do I change a location's ABN or business number?
      - Can I edit the business number on a location profile?
      instructions:
      - text: Set the business number of location {id} to {businessNumber}.
        slots:
          id: path.id
          businessNumber: requestBody.businessNumber
      - text: Update location {id} with business number {businessNumber}.
        slots:
          id: path.id
          businessNumber: requestBody.businessNumber
      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-location-profile-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.