Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Custom Field Data API
17 actions
17 updates
phrasing
extends
openapi/deputy-customfielddata-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.
What the actions change
x-apievangelist-phrasing
Targets 17 · first 16 shown; the file carries all of them
$.info
$.paths['/resource/CustomFieldData'].get
$.paths['/resource/CustomFieldData'].put
$.paths['/resource/CustomFieldData'].post
$.paths['/resource/CustomFieldData/BULK'].post
$.paths['/resource/CustomFieldData/INFO'].get
$.paths['/resource/CustomFieldData/PREDICT'].post
$.paths['/resource/CustomFieldData/QUERY'].post
$.paths['/resource/CustomFieldData/{id}'].get
$.paths['/resource/CustomFieldData/{id}'].put
$.paths['/resource/CustomFieldData/{id}'].post
$.paths['/resource/CustomFieldData/{id}'].delete
$.paths['/resource/CustomFieldData/{id}/COMMENTS'].get
$.paths['/resource/CustomFieldData/{id}/COMMENTS'].post
$.paths['/resource/CustomFieldData/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/CustomFieldData/{id}/HISTORY'].get
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 Deputy V1 Resource Custom Field Data API
version: 1.0.0
extends: openapi/deputy-customfielddata-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/CustomFieldData'].get
update:
x-apievangelist-phrasing:
intent: List custom field records
effect: read
questions:
- How do I see the custom field values for resources in my Deputy account?
- Can I pull all custom field records in one list?
instructions:
- text: List all custom field records.
- text: Show every custom field value for the resources I can see.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData'].put
update:
x-apievangelist-phrasing:
intent: Replace a custom field data record
effect: write
questions:
- How do I overwrite a custom field data record in full?
- Can I replace a custom field data record with a new value?
instructions:
- text: Replace custom field data record {id} in system {system} with {modified}.
slots:
id: requestBody.Id
system: requestBody.System
modified: requestBody.Modified
- text: Overwrite the full custom field data record {id} for {system}.
slots:
id: requestBody.Id
system: requestBody.System
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData'].post
update:
x-apievangelist-phrasing:
intent: Create a custom field data record
effect: write
questions:
- How do I add a new custom field data record?
- Can I create a custom field data record for a system?
instructions:
- text: Create custom field data record {id} in system {system} with {modified}.
slots:
id: requestBody.Id
system: requestBody.System
modified: requestBody.Modified
- text: Add a new custom field data record {id} for {system}.
slots:
id: requestBody.Id
system: requestBody.System
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/BULK'].post
update:
x-apievangelist-phrasing:
intent: Create or update many custom field data records
effect: write
questions:
- Can I create or update many custom field data records at once?
- How do I bulk upsert custom field data records?
instructions:
- text: Bulk upsert these custom field data records.
- text: Create or update multiple custom field data records in one request.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get custom field data field metadata
effect: read
questions:
- Which fields and types are available on custom field data?
- What associations does custom field data have?
instructions:
- text: Show the field metadata for custom field data.
- text: List the fields, types and associations of custom field data.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing custom field data record
effect: read
questions:
- Can I find the existing custom field data record that matches a partial payload?
- Which existing custom field data record matches this id and system?
instructions:
- text: Predict the matching custom field data record for {id} in {system}.
slots:
id: requestBody.Id
system: requestBody.System
- text: Find the existing custom field data record matching {id} and {system}.
slots:
id: requestBody.Id
system: requestBody.System
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search custom field data records
effect: read
questions:
- How do I search custom field data records by a field value?
- Can I sort and page through custom field data search results?
instructions:
- text: Search custom field data records where {search}.
slots:
search: requestBody.search
- text: Find custom field data records matching {search}, sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a custom field data record
effect: read
questions:
- What values does a specific custom field data record hold?
- Can I fetch one custom field data record by id?
instructions:
- text: Get custom field data record {id}.
slots:
id: path.id
- text: Show the values of custom field data record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a custom field record
effect: write
questions:
- How do I change the custom field data on a resource?
- Can I edit a custom field record by its id?
instructions:
- text: Update custom field record {id} with system {system} and modified {modified}.
slots:
id: path.id
system: requestBody.System
modified: requestBody.Modified
- text: Set custom field F01 to {f01} on record {id}, system {system}, modified {modified}.
slots:
f01: requestBody.F01
id: path.id
system: requestBody.System
modified: requestBody.Modified
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update a custom field value
effect: write
questions:
- Can I change one custom field value on a resource without resending the rest?
- Which fields are required when updating a custom field value?
instructions:
- text: Update custom field {field} on resource {id} to {value}.
slots:
field: requestBody.F01
id: path.id
value: requestBody.F01
- text: Patch custom field {field} on resource {id} with {value}.
slots:
field: requestBody.F01
id: path.id
value: requestBody.F01
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a custom field value
effect: destructive
questions:
- How do I remove a custom field value from a resource?
- Can I delete a custom field record by its id?
instructions:
- text: Delete custom field data {id}.
slots:
id: path.id
- text: Remove the custom field value record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a custom field value
effect: read
questions:
- What comments have been left on a custom field value?
- Can I read the comment history for a custom field record?
instructions:
- text: List comments on custom field data {id}.
slots:
id: path.id
- text: Show the comment history for custom field value {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a custom field value
effect: write
questions:
- How do I annotate a custom field value with a comment?
- Can I leave a note on a custom field record?
instructions:
- text: Comment {comment} on custom field data {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Add a note {comment} to custom field value {id}.
slots:
comment: requestBody.Comment
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a custom field value
effect: destructive
questions:
- How do I remove a comment from a custom field value?
- Can I delete one comment on a custom field record?
instructions:
- text: Delete comment {commentId} from custom field data {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove note {commentId} on custom field value {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history of a custom field value
effect: read
questions:
- Who changed a custom field value and when?
- Can I see the change history of a custom field record?
instructions:
- text: Show the change history of custom field data {id}.
slots:
id: path.id
- text: List edits made to custom field value {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CustomFieldData/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: See a custom field value as it was at a past time
effect: read
questions:
- What did a custom field value look like at a specific moment in the past?
- Can I travel back to a custom field record's state at a given timestamp?
instructions:
- text: Show custom field data {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel to the state of custom field value {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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-customfielddata-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.