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 Initialize API
version: 1.0.0
extends: openapi/salesforce-initialize-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['/services/auth/headless/init/registration'].post
update:
x-apievangelist-phrasing:
intent: Start headless user registration
effect: write
questions:
- How do I sign up a new customer from my own app without a Salesforce login page?
- Can the one-time password for registration be sent by SMS instead of email?
instructions:
- text: Start registration for {userdata} with password {password}, verifying by {method}.
slots:
userdata: requestBody.userdata
password: requestBody.password
method: requestBody.verificationmethod
- text: Register a new user {userdata} with custom fields {custom} and reCAPTCHA token {recaptcha}.
slots:
userdata: requestBody.userdata
custom: requestBody.customdata
recaptcha: requestBody.recaptcha
method: generated
generated: '2026-09-26'
- target: $.paths['/services/auth/headless/forgot_password'].post
update:
x-apievangelist-phrasing:
intent: Start a headless forgot-password flow
effect: write
questions:
- How can a user reset a forgotten password from my custom login screen?
- Does the headless forgot-password call need a reCAPTCHA token?
instructions:
- text: Start a password reset for {username}.
slots:
username: requestBody.username
- text: Send a forgot-password code to {username} with reCAPTCHA {recaptcha}.
slots:
username: requestBody.username
recaptcha: requestBody.recaptcha
method: generated
generated: '2026-09-26'
- target: $.paths['/services/auth/headless/init/passwordless/login'].post
update:
x-apievangelist-phrasing:
intent: Start a headless passwordless login
effect: write
questions:
- Can users log in with a one-time code instead of a password?
- Which verification methods does passwordless login support?
instructions:
- text: Start a passwordless login for {username} by {method}.
slots:
username: requestBody.username
method: requestBody.verificationmethod
- text: Send a login OTP to {username} using reCAPTCHA {recaptcha}.
slots:
username: requestBody.username
recaptcha: requestBody.recaptcha
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.