Vendasta · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Vendasta Options API

56 actions 56 updates phrasing extends openapi/vendasta-options-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

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

$.info
$.paths['/accountStats'].options
$.paths['/accountStats/{id}'].options
$.paths['/connectedAccounts/{id}'].options
$.paths['/connectedAccounts'].options
$.paths['/campaignInfo'].options
$.paths['/campaignInfo/{id}'].options
$.paths['/campaignStats'].options
$.paths['/campaignStats/{id}'].options
$.paths['/customers'].options
$.paths['/customers/{id}'].options
$.paths['/reviewRequests'].options
$.paths['/reviewRequestTemplates'].options
$.paths['/reviewRequestTemplates/{id}'].options
$.paths['/listingSyncListings'].options
$.paths['/listingScores/{id}'].options

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 Vendasta Options API
  version: 1.0.0
extends: openapi/vendasta-options-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: 55
- target: $.paths['/accountStats'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for the account stats list
      effect: read
      questions:
      - Which HTTP verbs can a browser use against the account stats listing endpoint?
      - Does the account stats collection answer a CORS preflight request?
      instructions:
      - text: Send a CORS preflight to the account stats collection and report the allowed methods.
      - text: Show me the headers the accountStats list endpoint returns for OPTIONS.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accountStats/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one account's stats
      effect: read
      questions:
      - What methods are permitted on the stats endpoint for a single connected ad account?
      - Will a cross-origin call to one account's stats record pass the CORS preflight?
      instructions:
      - text: Run an OPTIONS preflight on the stats record for connected account {id}.
        slots:
          id: path.id
      - text: List the HTTP verbs accepted by accountStats entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connectedAccounts/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one connected account
      effect: read
      questions:
      - Which verbs does the endpoint for an individual connected advertising account support?
      - Can my web app reach a single connected account record across origins?
      instructions:
      - text: Preflight connected advertising account {id} and tell me which methods it permits.
        slots:
          id: path.id
      - text: Get the CORS headers served for connectedAccounts item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connectedAccounts'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for the connected accounts list
      effect: read
      questions:
      - What HTTP methods does the connected accounts collection expose to browsers?
      - Is the listing of connected advertising accounts CORS-enabled?
      instructions:
      - text: Issue an OPTIONS request to the connectedAccounts collection.
      - text: Report the verbs browsers may use when listing connected ad accounts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaignInfo'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for campaign info list
      effect: read
      questions:
      - Which methods does the campaign info listing accept from a browser client?
      - Does the campaignInfo collection respond to OPTIONS preflights?
      instructions:
      - text: Preflight the campaign info collection and return its Allow header.
      - text: Tell me what verbs the list of campaign information supports for CORS.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaignInfo/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one campaign's info
      effect: read
      questions:
      - What verbs are allowed on the info endpoint for one specific campaign?
      - Will a browser preflight to a single campaign info record succeed?
      instructions:
      - text: Send OPTIONS to the campaign info record {id}.
        slots:
          id: path.id
      - text: Check which methods campaign {id} info permits cross-origin.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaignStats'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for campaign stats list
      effect: read
      questions:
      - Which HTTP methods can I call on the campaign statistics collection from the browser?
      - Is the campaignStats listing reachable through CORS?
      instructions:
      - text: Run a CORS preflight against the campaign statistics collection.
      - text: Return the methods allowed for listing campaign stats.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaignStats/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one campaign's stats
      effect: read
      questions:
      - What methods does the statistics endpoint for a single campaign accept?
      - Can a front-end fetch one campaign's stats record without a CORS error?
      instructions:
      - text: Preflight the stats record for campaign {id}.
        slots:
          id: path.id
      - text: Show the allowed verbs on campaignStats entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for the customers list
      effect: read
      questions:
      - Which verbs does the customers collection permit for cross-origin requests?
      - Does the customer listing endpoint support a browser OPTIONS preflight?
      instructions:
      - text: Send an OPTIONS request to the customers collection.
      - text: Report the CORS methods allowed when listing or adding customers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one customer
      effect: read
      questions:
      - What HTTP methods are allowed on an individual customer record?
      - Can a browser app call a single customer by ID across origins?
      instructions:
      - text: Preflight customer {id} and list its permitted verbs.
        slots:
          id: path.id
      - text: Get the CORS response headers for the customer record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reviewRequests'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for review requests
      effect: read
      questions:
      - Which methods does the review requests endpoint allow from a browser?
      - Does sending review requests work through a CORS preflight?
      instructions:
      - text: Run an OPTIONS preflight on the reviewRequests endpoint.
      - text: Tell me which HTTP verbs I can use for review requests cross-origin.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reviewRequestTemplates'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for review request templates
      effect: read
      questions:
      - What verbs does the review request templates collection support?
      - Is the list of review request templates accessible via CORS?
      instructions:
      - text: Preflight the review request templates collection.
      - text: Return the Allow header for listing reviewRequestTemplates.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reviewRequestTemplates/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one review template
      effect: read
      questions:
      - Which HTTP methods apply to a single review request template?
      - Can my browser client update one review template without CORS issues?
      instructions:
      - text: Send OPTIONS to review request template {id}.
        slots:
          id: path.id
      - text: List the verbs permitted on reviewRequestTemplates item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/listingSyncListings'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for listing sync listings
      effect: read
      questions:
      - Which methods does the listing sync listings endpoint accept cross-origin?
      - Does the listingSyncListings collection respond to preflight requests?
      instructions:
      - text: Preflight the listing sync listings collection.
      - text: Show the CORS verbs available for synced directory listings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/listingScores/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for a listing score
      effect: read
      questions:
      - What verbs are allowed on a business's listing score endpoint?
      - Will a browser be able to fetch a listing score record cross-origin?
      instructions:
      - text: Run OPTIONS on the listing score for business {id}.
        slots:
          id: path.id
      - text: Report the permitted methods for listingScores entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessLocations'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for business locations list
      effect: read
      questions:
      - Which HTTP verbs does the business locations collection allow for browsers?
      - Is creating or listing business locations CORS-enabled?
      instructions:
      - text: Send a preflight to the businessLocations collection.
      - text: Return the allowed methods for the list of business locations.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessLocations/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one business location
      effect: read
      questions:
      - What methods can I use on an individual business location record?
      - Does a single business location answer CORS preflights?
      instructions:
      - text: Preflight business location {id}.
        slots:
          id: path.id
      - text: Tell me which verbs the businessLocations record {id} supports.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for the users list
      effect: read
      questions:
      - Which verbs does the users collection accept from a web page?
      - Is the user listing endpoint reachable through a CORS preflight?
      instructions:
      - text: Issue OPTIONS against the users collection.
      - text: Report the HTTP methods allowed for listing and creating users.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one user
      effect: read
      questions:
      - What HTTP methods are permitted on a single user record?
      - Can a browser read one user by ID without CORS errors?
      instructions:
      - text: Preflight user {id} and return the allowed verbs.
        slots:
          id: path.id
      - text: Get the CORS headers for the users entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/purchases'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for purchases
      effect: read
      questions:
      - Which verbs does the purchases endpoint support for browser clients?
      - Does placing a purchase from a web page pass the CORS preflight?
      instructions:
      - text: Send OPTIONS to the purchases endpoint.
      - text: List the cross-origin methods allowed on purchases.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessCategories'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for business categories
      effect: read
      questions:
      - What methods does the business categories collection allow in the options endpoint group?
      - Is the business category list available to browsers via CORS?
      instructions:
      - text: Preflight the businessCategories collection.
      - text: Show the permitted verbs for looking up business categories.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for the orders collection
      effect: read
      questions:
      - Which HTTP methods does the orders collection allow cross-origin?
      - Can a browser list or submit sales orders past the CORS preflight?
      instructions:
      - text: Run an OPTIONS preflight on the orders collection.
      - text: Return the verbs allowed on the list of orders.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one order
      effect: read
      questions:
      - What verbs are permitted on an individual sales order record?
      - Does a single order by ID respond to CORS preflights?
      instructions:
      - text: Preflight order {id}.
        slots:
          id: path.id
      - text: Tell me which methods the orders entry {id} accepts from browsers.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}/relationships/customFields'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for an order's custom field links
      effect: read
      questions:
      - Which methods does an order's custom field relationships endpoint accept?
      - Can a browser read the custom field relationship IDs on an order cross-origin?
      instructions:
      - text: Send OPTIONS to the customFields relationship of order {id}.
        slots:
          id: path.id
      - text: Preflight the relationship links between order {id} and its custom fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{id}/customFields'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for an order's custom fields
      effect: read
      questions:
      - What verbs are allowed when fetching the custom fields nested under an order?
      - Is an order's embedded custom fields list CORS-enabled?
      instructions:
      - text: Preflight the custom fields listed under order {id}.
        slots:
          id: path.id
      - text: Report the allowed methods for orders/{id}/customFields.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orderCustomFields/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for an order custom fields record
      effect: read
      questions:
      - Which methods does a standalone order custom fields record allow?
      - Can a web app patch an orderCustomFields record after the CORS check?
      instructions:
      - text: Run OPTIONS on orderCustomFields record {id}.
        slots:
          id: path.id
      - text: Show the verbs the order custom field set {id} permits.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orderFulfillmentForms'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for fulfillment forms list
      effect: read
      questions:
      - What HTTP verbs does the order fulfillment forms collection support?
      - Are fulfillment forms listable from a browser via CORS?
      instructions:
      - text: Preflight the orderFulfillmentForms collection.
      - text: Return the methods allowed on the list of order fulfillment forms.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orderFulfillmentForms/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one fulfillment form
      effect: read
      questions:
      - Which verbs apply to a single order fulfillment form record?
      - Will a browser pass the preflight for one fulfillment form by ID?
      instructions:
      - text: Send OPTIONS to fulfillment form {id}.
        slots:
          id: path.id
      - text: Check the CORS methods on orderFulfillmentForms entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{id}/relationships/businessLocations'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for a user's location links
      effect: read
      questions:
      - What methods does the endpoint linking a user to business locations accept?
      - Can I manage which locations a user can access from a browser without CORS errors?
      instructions:
      - text: Preflight the business location relationships of user {id}.
        slots:
          id: path.id
      - text: Report the verbs allowed for users/{id}/relationships/businessLocations.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automationRuns'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for automation runs
      effect: read
      questions:
      - Which HTTP methods does the automation runs endpoint support cross-origin?
      - Is starting an automation run from a web page allowed by CORS?
      instructions:
      - text: Run an OPTIONS preflight on automationRuns.
      - text: Tell me what verbs the automation runs endpoint allows.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automations'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for the automations list
      effect: read
      questions:
      - What verbs does the automations collection permit for browsers?
      - Does listing automations support a CORS preflight?
      instructions:
      - text: Preflight the automations collection.
      - text: Return the allowed HTTP methods for listing automation workflows.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/automations/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one automation
      effect: read
      questions:
      - Which methods are allowed on an individual automation record?
      - Can a browser fetch one automation by ID through CORS?
      instructions:
      - text: Send OPTIONS to automation {id}.
        slots:
          id: path.id
      - text: List the verbs automations entry {id} permits cross-origin.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for the sales accounts list
      effect: read
      questions:
      - What HTTP methods does the sales accounts collection accept from browsers?
      - Is the salesAccounts listing CORS-enabled?
      instructions:
      - text: Preflight the salesAccounts collection.
      - text: Report which verbs are allowed for listing sales accounts.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one sales account
      effect: read
      questions:
      - Which verbs does a single sales account record allow?
      - Will one sales account by ID respond to a browser preflight?
      instructions:
      - text: Run OPTIONS on sales account {id}.
        slots:
          id: path.id
      - text: Show the CORS methods for the salesAccounts entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptionAssignments'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for subscription assignments
      effect: read
      questions:
      - What methods does the subscription assignments collection allow for a business location?
      - Is listing subscription assignments reachable cross-origin?
      instructions:
      - text: Preflight subscription assignments filtered to business location {location}.
        slots:
          location: query.filter[businessLocationId]
      - text: Return the verbs allowed on subscriptionAssignments for location {location}.
        slots:
          location: query.filter[businessLocationId]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for subscriptions
      effect: read
      questions:
      - Which HTTP verbs does the subscriptions collection accept from a browser?
      - Can I list a partner's subscriptions cross-origin after a CORS preflight?
      instructions:
      - text: Send OPTIONS to subscriptions for partner {partner}.
        slots:
          partner: query.filter[partner.id]
      - text: Preflight subscriptions for partner {partner} at business location {location}.
        slots:
          partner: query.filter[partner.id]
          location: query.filter[businessLocation.id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptionAssignments/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one subscription assignment
      effect: read
      questions:
      - What verbs are allowed on an individual subscription assignment?
      - Does a single subscription assignment by ID support CORS?
      instructions:
      - text: Preflight subscription assignment {id}.
        slots:
          id: path.id
      - text: List allowed methods for subscriptionAssignments entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptionAssignments/{id}/actions/requestCancellation'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for requesting cancellation
      effect: read
      questions:
      - Which methods does the request-cancellation action on a subscription assignment accept?
      - Can a browser trigger a subscription cancellation request past CORS?
      instructions:
      - text: Preflight the requestCancellation action for assignment {id}.
        slots:
          id: path.id
      - text: Tell me the verbs allowed to request cancelling subscription assignment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptionAssignments/{id}/actions/undoCancellation'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for undoing a cancellation
      effect: read
      questions:
      - What verbs does the undo-cancellation action for a subscription assignment support?
      - Is reversing a pending cancellation callable from a browser?
      instructions:
      - text: Preflight the undoCancellation action for assignment {id}.
        slots:
          id: path.id
      - text: Report methods permitted to undo the cancellation on subscription assignment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts/{id}/relationships/customFields'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for a sales account's field links
      effect: read
      questions:
      - Which methods does a sales account's custom field relationships endpoint allow?
      - Can I read custom field relationship IDs for a sales account cross-origin?
      instructions:
      - text: Send OPTIONS to the customFields relationship of sales account {id}.
        slots:
          id: path.id
      - text: Preflight the relationship links from sales account {id} to its custom fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccounts/{id}/customFields'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for a sales account's custom fields
      effect: read
      questions:
      - What verbs apply to the custom fields nested under a sales account?
      - Is a sales account's embedded custom field list CORS-enabled?
      instructions:
      - text: Preflight the custom fields listed under sales account {id}.
        slots:
          id: path.id
      - text: Return allowed methods for salesAccounts/{id}/customFields.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/salesAccountCustomFields/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for a sales account fields record
      effect: read
      questions:
      - Which methods does a standalone salesAccountCustomFields record accept?
      - Can a browser update one sales account custom field set after preflight?
      instructions:
      - text: Run OPTIONS on salesAccountCustomFields record {id}.
        slots:
          id: path.id
      - text: Show the verbs sales account custom field set {id} permits.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{id}/customFields'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for a user's custom fields
      effect: read
      questions:
      - What methods does the custom fields list nested under a user allow?
      - Is a user's embedded custom field collection reachable via CORS?
      instructions:
      - text: Preflight the custom fields listed under user {id}.
        slots:
          id: path.id
      - text: Report the verbs allowed for users/{id}/customFields.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{id}/actions/sendWelcomeEmail'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for sending a welcome email
      effect: read
      questions:
      - Which verbs does the send-welcome-email action for a user accept?
      - Can a web page trigger a user's welcome email without a CORS failure?
      instructions:
      - text: Preflight the sendWelcomeEmail action for user {id}.
        slots:
          id: path.id
      - text: Tell me what methods are allowed to send user {id} their welcome email.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/userCustomFields/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for a user custom fields record
      effect: read
      questions:
      - What verbs does a standalone userCustomFields record permit?
      - Can a browser patch one user custom field set after the preflight?
      instructions:
      - text: Run OPTIONS on userCustomFields record {id}.
        slots:
          id: path.id
      - text: Show the methods user custom field set {id} allows.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/productCustomFields/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for product custom fields
      effect: read
      questions:
      - Which methods does a productCustomFields record accept cross-origin?
      - Is a product's custom field set reachable from a browser via CORS?
      instructions:
      - text: Preflight productCustomFields record {id}.
        slots:
          id: path.id
      - text: List the verbs permitted on product custom field set {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countries'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for the countries list
      effect: read
      questions:
      - What HTTP methods does the countries collection allow for browsers?
      - Can a front-end load the country list cross-origin?
      instructions:
      - text: Send OPTIONS to the countries collection.
      - text: Return allowed verbs for listing countries.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countries/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one country
      effect: read
      questions:
      - Which verbs are permitted on a single country record?
      - Does one country by ID support a CORS preflight?
      instructions:
      - text: Preflight country {id}.
        slots:
          id: path.id
      - text: Report the methods allowed on countries entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countryRegions'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for country regions list
      effect: read
      questions:
      - What methods does the country regions collection accept cross-origin?
      - Can a browser list states and provinces via the countryRegions endpoint?
      instructions:
      - text: Preflight the countryRegions collection.
      - text: Show which verbs are allowed for listing country regions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/countryRegions/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one country region
      effect: read
      questions:
      - Which verbs apply to an individual country region record?
      - Is one state or province by ID reachable through CORS?
      instructions:
      - text: Send OPTIONS to country region {id}.
        slots:
          id: path.id
      - text: List the allowed methods on countryRegions entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partnerActivatableProducts/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for one activatable product
      effect: read
      questions:
      - What methods does a single partner activatable product record allow?
      - Can a browser read one activatable product by ID cross-origin?
      instructions:
      - text: Preflight partner activatable product {id}.
        slots:
          id: path.id
      - text: Return the verbs permitted on partnerActivatableProducts entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partnerActivatableProducts'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for activatable products list
      effect: read
      questions:
      - Which HTTP methods does the partner activatable products collection support?
      - Is the list of products a partner can activate CORS-enabled?
      instructions:
      - text: Send OPTIONS to the partnerActivatableProducts collection.
      - text: Report allowed verbs for listing the products a partner can activate.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/businessLocationReviews'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods for location reviews
      effect: read
      questions:
      - What verbs does the business location reviews endpoint accept from browsers?
      - Can a web app pull a location's reviews past the CORS check?
      instructions:
      - text: Preflight the businessLocationReviews collection.
      - text: Tell me the methods allowed for fetching business location reviews.
      method: generated
      generated: '2026-10-01'


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vendasta/refs/heads/main/overlays/vendasta-options-api-phrasing-overlay.yaml

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/vendasta-options-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.