Salesforce · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Salesforce Create API
19 actions
19 updates
phrasing
extends
openapi/salesforce-create-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Salesforce's API. It is a proposal applied on top of the contract, not a document Salesforce publishes.
What the actions change
x-apievangelist-phrasing
Targets 19 · first 16 shown; the file carries all of them
$.info
$.paths['/data/v64.0/jobs/query'].post
$.paths['/data/v64.0/jobs/ingest'].post
$.paths['/data/v64.0/named-credentials/credential'].post
$.paths['/data/v64.0/named-credentials/external-credentials'].post
$.paths['/data/v64.0/named-credentials/named-credential-setup'].post
$.paths['/data/v64.0/tooling/sobjects/NamedCredential'].post
$.paths['/data/v64.0/connect/business-rules/decision-table/definitions'].post
$.paths['/data/v64.0/connect/fundraising/gifts'].post
$.paths['/data/v64.0/connect/fundraising/commitments'].post
$.paths['/data/v64.0/tooling/sobjects/EventRelayConfig'].post
$.paths['/data/v64.0/tooling/sobjects/ManagedEventSubscription'].post
$.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}'].post
$.paths['/data/v64.0/commerce/payments/payment-methods'].post
$.paths['/data/v64.0/commerce/quotes/actions/place'].post
$.paths['/data/v64.0/actions/standard/createOrderFromQuote'].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 Salesforce Create API
version: 1.0.0
extends: openapi/salesforce-create-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 18
- target: $.paths['/data/v64.0/jobs/query'].post
update:
x-apievangelist-phrasing:
intent: Start a bulk query job to export records
effect: write
questions:
- What's the way to export a very large SOQL result set in bulk?
- Can I pick the column delimiter and line ending for a bulk query export?
instructions:
- text: Start a bulk query job for the SOQL query {query}.
slots:
query: requestBody.query
- text: Create a bulk {operation} job for {query} using {columnDelimiter} as the delimiter.
slots:
operation: requestBody.operation
query: requestBody.query
columnDelimiter: requestBody.columnDelimiter
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/jobs/ingest'].post
update:
x-apievangelist-phrasing:
intent: Open a bulk ingest job for an object
effect: write
questions:
- What do I need to start a bulk data load into an object?
- Can one ingest job insert records into an object like Contact?
instructions:
- text: Create a bulk ingest job to {operation} records on the {object} object.
slots:
operation: requestBody.operation
object: requestBody.object
- text: Open an ingest job for {object} so I can load a CSV.
slots:
object: requestBody.object
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/named-credentials/credential'].post
update:
x-apievangelist-phrasing:
intent: Store a credential for a named principal
effect: write
questions:
- How do I store secrets for a named principal on an external credential?
- Which principal types can I attach stored credentials to when creating one?
instructions:
- text: Create a credential for principal {principalName} on external credential {externalCredential}.
slots:
principalName: requestBody.principalName
externalCredential: requestBody.externalCredential
- text: Store {credentials} for the {principalType} principal {principalName}.
slots:
credentials: requestBody.credentials
principalType: requestBody.principalType
principalName: requestBody.principalName
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/named-credentials/external-credentials'].post
update:
x-apievangelist-phrasing:
intent: Create an external credential for callouts
effect: write
questions:
- What's involved in setting up a new external credential for callout authentication?
- Can I add custom headers when I define an external credential?
instructions:
- text: Create an external credential named {developerName} labeled {masterLabel}.
slots:
developerName: requestBody.developerName
masterLabel: requestBody.masterLabel
- text: Set up external credential {developerName} using the {authenticationProtocol} protocol.
slots:
developerName: requestBody.developerName
authenticationProtocol: requestBody.authenticationProtocol
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/named-credentials/named-credential-setup'].post
update:
x-apievangelist-phrasing:
intent: Create a named credential for a callout URL
effect: write
questions:
- Which fields does a new named credential need to point at an endpoint URL?
- Can a new named credential reference external credentials I already have?
instructions:
- text: Create a named credential {developerName} that calls {calloutUrl}.
slots:
developerName: requestBody.developerName
calloutUrl: requestBody.calloutUrl
- text: Set up named credential {masterLabel} of type {type} linked to {externalCredentials}.
slots:
masterLabel: requestBody.masterLabel
type: requestBody.type
externalCredentials: requestBody.externalCredentials
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/NamedCredential'].post
update:
x-apievangelist-phrasing:
intent: Create a named credential via the Tooling API
effect: write
questions:
- Can I create a named credential as a Tooling API metadata record?
- What does the Tooling API need to add a NamedCredential by full name?
instructions:
- text: Create a Tooling API named credential with full name {FullName}.
slots:
FullName: requestBody.FullName
- text: Add NamedCredential {FullName} through the Tooling API with metadata {Metadata}.
slots:
FullName: requestBody.FullName
Metadata: requestBody.Metadata
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/connect/business-rules/decision-table/definitions'].post
update:
x-apievangelist-phrasing:
intent: Define a new decision table
effect: write
questions:
- How do I define a new decision table for business rules?
- Can a decision table take its rows from a source object?
instructions:
- text: Create decision table definition {fullName} sourced from {sourceObject}.
slots:
fullName: requestBody.fullName
sourceObject: requestBody.sourceObject
- text: Define decision table {setupName} with status {status} and condition type {conditionType}.
slots:
setupName: requestBody.setupName
status: requestBody.status
conditionType: requestBody.conditionType
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/connect/fundraising/gifts'].post
update:
x-apievangelist-phrasing:
intent: Record donation gift transactions
effect: write
questions:
- Can I record donations and create or match the donor in the same request?
- Is it possible to create several gift transactions with designations at once?
instructions:
- text: Record the gift transactions {gifts}.
slots:
gifts: requestBody.gifts
- text: Create gifts {gifts} using processing options {processingOptions}.
slots:
gifts: requestBody.gifts
processingOptions: requestBody.processingOptions
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/connect/fundraising/commitments'].post
update:
x-apievangelist-phrasing:
intent: Create recurring donation commitments
effect: write
questions:
- How do I set up a recurring gift commitment for a donor?
- Does a gift commitment take a start date and a transaction period?
instructions:
- text: Create the gift commitments {commitments}.
slots:
commitments: requestBody.commitments
- text: Set up recurring donor commitments {commitments} with options {processingOptions}.
slots:
commitments: requestBody.commitments
processingOptions: requestBody.processingOptions
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/EventRelayConfig'].post
update:
x-apievangelist-phrasing:
intent: Create an event relay configuration
effect: write
questions:
- Can I set up a relay that sends platform events to an external event bus?
- What metadata does a new EventRelayConfig record need?
instructions:
- text: Create event relay {FullName} with metadata {Metadata}.
slots:
FullName: requestBody.FullName
Metadata: requestBody.Metadata
- text: Set up a new event relay configuration named {FullName}.
slots:
FullName: requestBody.FullName
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/tooling/sobjects/ManagedEventSubscription'].post
update:
x-apievangelist-phrasing:
intent: Create a managed event subscription
effect: write
questions:
- Is there a way to create a managed subscription to an event channel?
- What does a ManagedEventSubscription record need when I create it?
instructions:
- text: Create managed event subscription {FullName}.
slots:
FullName: requestBody.FullName
- text: Add a managed event subscription {FullName} with metadata {Metadata}.
slots:
FullName: requestBody.FullName
Metadata: requestBody.Metadata
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/sobjects/{SOBJECT_API_NAME}'].post
update:
x-apievangelist-phrasing:
intent: Insert a record into any object
effect: write
questions:
- Can I insert a new record into any standard or custom object with the sObject resource?
- What's the minimum needed to create an Account with just a name?
instructions:
- text: Create a new {SOBJECT_API_NAME} record named {Name}.
slots:
SOBJECT_API_NAME: path.SOBJECT_API_NAME
Name: requestBody.Name
- text: Insert a record into {SOBJECT_API_NAME} through the sObject REST resource.
slots:
SOBJECT_API_NAME: path.SOBJECT_API_NAME
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/commerce/payments/payment-methods'].post
update:
x-apievangelist-phrasing:
intent: Save a card payment method
effect: write
questions:
- How do I save a customer's card as a payment method through a payment gateway?
- Which contact details are required when storing a new card payment method?
instructions:
- text: Create a card payment method on gateway {paymentGatewayId} for {email}.
slots:
paymentGatewayId: requestBody.paymentGatewayId
email: requestBody.email
- text: Save card {cardPaymentMethod} as a payment method via gateway {paymentGatewayId}.
slots:
cardPaymentMethod: requestBody.cardPaymentMethod
paymentGatewayId: requestBody.paymentGatewayId
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/commerce/quotes/actions/place'].post
update:
x-apievangelist-phrasing:
intent: Place a subscription quote
effect: write
questions:
- Can I create or update a subscription quote in a single call?
- Is there a pricing preference I can set when placing a quote?
instructions:
- text: Place the quote described by {graph}.
slots:
graph: requestBody.graph
- text: Create or update a quote from {graph} with pricing preference {pricingPref}.
slots:
graph: requestBody.graph
pricingPref: requestBody.pricingPref
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/actions/standard/createOrderFromQuote'].post
update:
x-apievangelist-phrasing:
intent: Convert a quote into an order
effect: write
questions:
- How do I turn an accepted quote into an order?
- Is there a standard action that creates an order from a quote?
instructions:
- text: Create an order from the quote in {inputs}.
slots:
inputs: requestBody.inputs
- text: Convert quote {inputs} into an order.
slots:
inputs: requestBody.inputs
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/records'].post
update:
x-apievangelist-phrasing:
intent: Create a record via the UI API
effect: write
questions:
- Can I create a record through the User Interface API with its validation rules?
- Is it possible to save a new UI API record even when duplicate rules flag it?
instructions:
- text: Create a {apiName} record with fields {fields} via the UI API.
slots:
apiName: requestBody.apiName
fields: requestBody.fields
- text: Create a {apiName} record with {fields}, allow duplicates set to {allowSaveOnDuplicate}.
slots:
apiName: requestBody.apiName
fields: requestBody.fields
allowSaveOnDuplicate: requestBody.allowSaveOnDuplicate
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/record-defaults/create/{SOBJECT_API_NAME}'].get
update:
x-apievangelist-phrasing:
intent: Get default values for a new record
effect: read
questions:
- What default field values does a new record of an object start with?
- Which layout fields appear when someone creates a new record of this object?
instructions:
- text: Get the create-record defaults for {SOBJECT_API_NAME}.
slots:
SOBJECT_API_NAME: path.SOBJECT_API_NAME
- text: Show default field values for a new {SOBJECT_API_NAME}.
slots:
SOBJECT_API_NAME: path.SOBJECT_API_NAME
method: generated
generated: '2026-09-26'
- target: $.paths['/data/v64.0/ui-api/favorites'].post
update:
x-apievangelist-phrasing:
intent: Add an item to a user's favorites
effect: write
questions:
- How do I add a record or list view to my favorites?
- Can I set the sort order of a new favorite?
instructions:
- text: Add {target} to my favorites as {name}.
slots:
target: requestBody.target
name: requestBody.name
- text: Create a favorite named {name} for {targetType} {target} at position {sortOrder}.
slots:
name: requestBody.name
targetType: requestBody.targetType
target: requestBody.target
sortOrder: requestBody.sortOrder
method: generated
generated: '2026-09-26'
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/salesforce-create-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.