Vendasta · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for CRM Opportunity Service API
7 actions
7 updates
phrasing
extends
openapi/vendasta-crmopportunityservice-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Vendasta's API. It is a proposal applied on top of the contract, not a document Vendasta publishes.
What the actions change
x-apievangelist-phrasing
Targets 7
$.info
$.paths['/v1/crm/opportunity/create'].post
$.paths['/v1/crm/opportunity/delete'].post
$.paths['/v1/crm/opportunity/field-options'].post
$.paths['/v1/crm/opportunity/get-multi'].post
$.paths['/v1/crm/opportunity/list'].post
$.paths['/v1/crm/opportunity/update'].post
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 CRM Opportunity Service API
version: 1.0.0
extends: openapi/vendasta-crmopportunityservice-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 6
- target: $.paths['/v1/crm/opportunity/create'].post
update:
x-apievangelist-phrasing:
intent: Create a CRM opportunity
effect: write
questions:
- How do I add a new sales opportunity to the CRM?
- Can I log a deal as an opportunity record for a partner namespace?
instructions:
- text: 'Create an opportunity in namespace {namespace} with these details: {crmObject}.'
slots:
namespace: requestBody.namespace
crmObject: requestBody.crmObject
- text: Add a new CRM deal to {namespace}.
slots:
namespace: requestBody.namespace
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/crm/opportunity/delete'].post
update:
x-apievangelist-phrasing:
intent: Delete a CRM opportunity
effect: destructive
questions:
- Can I remove an opportunity from the CRM once a deal is dead?
- What do I need to permanently delete one opportunity record?
instructions:
- text: Delete opportunity {crmObjectId} in namespace {namespace}.
slots:
crmObjectId: requestBody.crmObjectId
namespace: requestBody.namespace
- text: Remove the CRM deal {crmObjectId} from {namespace}.
slots:
crmObjectId: requestBody.crmObjectId
namespace: requestBody.namespace
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/crm/opportunity/field-options'].post
update:
x-apievangelist-phrasing:
intent: List allowed values for an opportunity field
effect: read
questions:
- What values can I pick for a dropdown field on opportunities, like stage?
- Can I search the selectable options of one opportunity field by keyword?
instructions:
- text: Show the available options for opportunity field {fieldId} in {namespace}.
slots:
fieldId: requestBody.fieldId
namespace: requestBody.namespace
- text: Find options containing {searchTerm} for opportunity field {fieldId} in {namespace}.
slots:
searchTerm: requestBody.searchTerm
fieldId: requestBody.fieldId
namespace: requestBody.namespace
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/crm/opportunity/get-multi'].post
update:
x-apievangelist-phrasing:
intent: Fetch several opportunities by ID
effect: read
questions:
- Can I load a batch of specific opportunities in one call when I have their IDs?
- Is it possible to return only certain fields for a set of known opportunities?
instructions:
- text: Get opportunities {crmObjectIds} from namespace {namespace}.
slots:
crmObjectIds: requestBody.crmObjectIds
namespace: requestBody.namespace
- text: Fetch deals {crmObjectIds} in {namespace}, returning only fields {fieldMask}.
slots:
crmObjectIds: requestBody.crmObjectIds
namespace: requestBody.namespace
fieldMask: requestBody.fieldMask
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/crm/opportunity/list'].post
update:
x-apievangelist-phrasing:
intent: List and search CRM opportunities
effect: read
questions:
- Which opportunities are open in my CRM pipeline right now?
- Can I filter, search and sort the opportunity list?
instructions:
- text: List opportunities in namespace {namespace}.
slots:
namespace: requestBody.namespace
- text: Search opportunities in {namespace} for {search}, sorted by {sortBy}.
slots:
namespace: requestBody.namespace
search: requestBody.search
sortBy: requestBody.sortBy
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/crm/opportunity/update'].post
update:
x-apievangelist-phrasing:
intent: Update a CRM opportunity
effect: write
questions:
- Can I move an existing opportunity to a new stage or change its amount?
- How can I edit just some fields on an opportunity I already created?
instructions:
- text: Update the existing opportunity in {namespace} with {crmObject}.
slots:
namespace: requestBody.namespace
crmObject: requestBody.crmObject
- text: Change only fields {fieldMask} on the opportunity {crmObject} in {namespace}.
slots:
fieldMask: requestBody.fieldMask
crmObject: requestBody.crmObject
namespace: requestBody.namespace
method: generated
generated: '2026-10-01'
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/vendasta-crmopportunityservice-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.