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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Salesforce Bulk API
version: 1.0.0
extends: openapi/salesforce-bulk-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: 3
- target: $.paths['/async/64.0/job'].post
update:
x-apievangelist-phrasing:
intent: Create a Bulk API 1.0 job
effect: write
questions:
- How do I start a Bulk API 1.0 job to insert Accounts from CSV?
- Which operations, like insert, upsert or delete, can a bulk job run?
instructions:
- text: Create a bulk {operation} job for {object} with content type {content_type}.
slots:
operation: requestBody.operation
object: requestBody.object
content_type: requestBody.contentType
- text: Start a Bulk API {operation} job on {object}.
slots:
operation: requestBody.operation
object: requestBody.object
method: generated
generated: '2026-09-26'
- target: $.paths['/async/64.0/job//spec'].post
update:
x-apievangelist-phrasing:
intent: Upload a transformation spec to a bulk job
effect: write
questions:
- How do I map CSV columns to fields with a transformation spec for a bulk job?
- Can I send a compressed spec file to a Bulk API 1.0 job?
instructions:
- text: Upload a transformation spec to my bulk job using {content_encoding} encoding.
slots:
content_encoding: header.Content-Encoding
- text: Add a field-mapping spec file to the bulk job, compressed as {content_encoding}.
slots:
content_encoding: header.Content-Encoding
method: generated
generated: '2026-09-26'
- target: $.paths['/async/64.0/job/'].post
update:
x-apievangelist-phrasing:
intent: Close or abort a Bulk API 1.0 job
effect: write
questions:
- How do I close a bulk job so no more batches are added?
- Can I abort a Bulk API 1.0 job by changing its state?
instructions:
- text: Set the bulk job state to {state}.
slots:
state: requestBody.state
- text: Close my Bulk API 1.0 job by setting state {state}.
slots:
state: requestBody.state
method: generated
generated: '2026-09-26'
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.