Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Chatter Resources
Request Bodies
Response Bodies
Action Link Definition
Action Link Diagnostic
Action Link Group Definition
Activity Reminder
Activity Reminders Collection
Address
Adjust Order Summary Output
Alternative
Alternative Payment Method Output
Announcement
Announcement Page
App OAuth Credentials
App OAuth Credentials Collection
App OAuth Usage
App OAuth Usage Collection
App OAuth Usage Token
App OAuth Usage Token Collection
App OAuth Usage User
App OAuth Usage User Collection
Application Context
Approval Capability
Approval Post Template Field
Approval Social Post Intent
Article Item
Article Recommendations Runtime Metric
Article Recommendations Runtime Metrics
Article Summary
Asset Action Output
Asset Action Source Output
Asset State Period Output
Asset Output
Asset Result Output
Asset File
Associated Actions Capability
Async Output
Audience
Audience Collection
Audience Criteria Details
Audience Criterion Details
Audience Target
Audience Target Assignment
Authorization Adjustment Output
Authorization Gateway Response Output
Authorization Output
Authorization Reversal Gateway Response Output
Authorization Reversal Output
Available Location Output
Available Territory Slots
Available Territory Slots List
Available Territory Slots Output
Average Distance Result Output
AWS Inbound Network Connection Properties
AWS Outbound Network Connection Properties
Banner Capability
Banner Photo
Batch Result Item
Batch Results
Bookmark Summary
Bookmarks Capability
Boost and Bury Rule
Boost and Bury Rules Collection
Boost and Bury Rule Condition
Boost and Bury Rule Target Expression
Bot Info
Bot Version Activation Info
Buyer Profile Detail
Calculate Taxes
Calculate Taxes Info
Calculate Taxes Line Item
Call Collaboration Capability
Candidate Answers Status
Canvas Capability
Capacity Response Output
Capture Gateway Response Output
Capture Output
Card Payment Method Output
Cart Adjustment Group
Cart Coupon
Cart Coupon Collection
Cart Coupon List
Cart Inventory Item Reservation (Pilot)
Cart Inventory Reservation (Pilot)
Cart Item
Cart Item Basic
Cart Item Basic Result
Cart Item Collection
Cart Item Output
Cart Item Price Adjustment
Cart Item Product
Cart Item Promotion Collection
Cart Item Result
Cart Item Without Price
Cart Message
Cart Messages Summary
Cart Messages Visibility Result
Cart Output
Cart Product Attribute
Cart Promotion
Cart Promotion Collection
Cart Summary
Cart to Wishlist Result
Case Comment Capability
Category Import
Change Item Output
Chatter Activity
Chatter Activity Summary
Chatter Directory
Chatter Influence
Chatter Likes Capability
Chatter Recommendation
Chatter Recommendations
Chatter Stream
Chatter Stream Collection
Checkout
Checkout Address
Checkout Error
Checkout Order
Checkout Payment
Class Taxes
Clean Record Result
Clean Record Result Collection
Clean Rule Data Service
Clean Rule Data Service Collection
Clean Rule Data Service Metrics
Clean Rule Data Service Metrics Collection
Clean Rule Status
Clean Rule Status Collection
ClientInfo
Client-Side Payment Configuration
Close Capability
CMS Content Search Item
CMS Content Search Result
Comment
Comment Capabilities
Comment Page
Comment Summary
Comments Capability
Commerce Action Result
Commerce Address
Commerce Address Collection
Commerce Einstein Activity Export Job
Commerce Einstein Activity Purge Job
Commerce Einstein Configuration
Commerce Einstein Recommendation Results
Commerce Einstein Status
Commerce Extension
Commerce Extension Collection
Commerce Extension Mapping
Commerce Extension Mappings Collection
Commerce Extension Provider Apex Class
Commerce Extension Provider
Commerce Extension Provider Collection
Commerce Product Search Results
Commerce Search Index
Commerce Search Index Collection
Commerce Search Index Log
Commerce Search Index Log Collection
Commerce Product Selling Model Information
Commerce Product Summary
Commerce Product Summary Collection
Commerce Webstore Extension Mapping
Community
Community Create
Community Page
Community Publish
Community Summary
Community Template
Community Template Collection
Company Verify Summary
Confirm Held FO Capacity Output
Confirm Held FO Capacity Response Output
Connect Directory
Connectors Call Coaching Status
Connectors Call Coaching User Info
Connectors Voice Call List Result
Connectors Voice Call Result
Contact Information
Content
Content Capability
Conversation Application Definition Detail
Conversation Bulk Upload
Conversation Bulk Upload Status
Conversation Bulk Upload Statuses
Conversation Bulk Uploads
Conversation Detail
Conversation Entries
Conversation Entries Update
Conversation Entry
Conversation Entry Update
Conversation Participant
Conversation Summary
Conversation Summary Collection
Conversation Unread Count
Coupon
Coupon Code Redemption Collection
Coupon Code Redemption Result
Create Credit Memo Output
Create Invoice From Change Orders Output
Create Multiple Invoices From Change Orders Output
Create Order Payment Summary Output
Credential
Credential Custom Header
Credential Value
Custom Domain
Custom Domain Collection
Custom Domain Detail
Custom List Audience Criteria
Custom Recommendation Audience
Custom Recommendation Audience Collection
Custom Recommendation Definition
Custom Recommendation Definition Collection
Dashboard Component Snapshot
Dashboard Component Snapshot Capability
Data Category
Data Category Group
Data Category Group Collection
Data Integration Credit
Data Integration Credit Objects
Delete Intent
Delete Intents
Delete Social Post Intent
Delivery Group
Delivery Group Collection
Delivery Method
Digest Job
Direct Message Capability
Direct Message Member Collection
Direct Message Membership Activity
Direct Message Membership Activity Collection
Distance Calculation Output
Distinct Facet Value
Distinct Value Search Facet
Distribute Picked Quantities Output
Downvote Summary
Duplicate Directory
Duplicate Job
Duplicate Job Collection
Duplicate Job Definition
Duplicate Job Definition Collection
Edit Capability
Einstein LLM Generation Item
Einstein LLM Generations Safety Score
Einstein Prompt Template Generations
Email Address
Email Attachment
Email Merge Field
Email Merge Field Collection
Email Message Capability
Emoji
Emoji Collection
Engagement Channel Type List Result
Engagement Channel Type Output
Engagement Channel Type Result
Enhanced Link Capability
Ensure Funds Async Output
Ensure Refunds Async Output
Entity Label
Environment Hub My Domain Validation
Environment Hub OAuth URL
Environment Hub Sign-up Member Validation
Environment Hub SSO User Mapping Validation
Error Message
Error Response Output
Error with Output
Experience Model Property Type Collection
Experience Model Property Type Detail
Experience Model Property Type Summary
Explanation Details
Explanation Summary
Extended Fields
Extension
Extension Definition
Extension Definition Collection
Extensions Capability
External Credential
External Credential List
External Credential Parameter
External Credential Principal
External Credential Principal Access
External File Permission Information
External Managed Account Address Output
External Managed Account Collection Output
External Managed Account Output
Facetable Attribute
Facetable Attributes Collection
Favorite
Favorites Page
Features
Feed
Feed Directory
Feed Directory Item
Feed Element Capabilities
Feed Element Page
Feed Enabled Entity Summary
Feed Entity Is Editable
Feed Entity Not Available Summary
Feed Entity Read Summary
Feed Entity Share Capability
Feed Item
Feed Item Body
Feed Item Preamble Message Body
Feed Item Summary
Feed Modified Info
Feed Poll Choice
Feed Post Summary
Feed Read Summary
Feed Tracked Change
Field Value
File Detail
File Preview
File Preview Collection
File Preview URL
File Share Link
File Shares
File Shares Page
File Summary
File Summary Page
Files Capability
Files Connect Allowed Item Type Collection
Files Connect Field Definition
Files Connect Item Type Detail
Files Connect Item Type Summary
Files Connect Permission
Files Connect Permission Collection
Files Connect Permission Type
Files Connect Provider Type
Files Connect Repository
Files Connect Repository Authentication
Files Connect Repository Collection
Files Connect Repository Features
Find Routes With Fewest Splits Output
Find Routes With Fewest Splits Using OCI Output
Find Routes With Fewest Splits With Inventory Output
Flat Feed
Flat Feed Item
Folder
Folder Item
Folder Item Page
Folder Path
Folder Share Link
Follow Social Persona Intent
Follow Social Persona Intents
Follower Page
Following Counts
Following Page
Forecasting Ancestors
Forecasting Manager
Forecasting Manager Ancestors
Forecasting My Forecasts
Forecasting My Forecasts Collection
Forecasting User
Forecasting User Access
Forecasting User Access Collection
Forecasting User Collection
Form
Form Field
Form Fields
Form Submission
Formula Scope
Fulfillment Group Output
Fulfillment Order Cancel Line Items Output
Fulfillment Order Invoice Output
Fulfillment Order Output
Gateway Log Output
Generic Bundle Capability
Generic Feed Element
Get FO Capacity Values Output
Global Product Import
Group
Group Chatter Settings
Group Detail
Group Information
Group Member
Group Member Page
Group Membership Request
Group Membership Request Collection
Group Page
Group Record
Group Record Page
Hide Social Post Intent
Hold FO Capacity Output
Hold FO Capacity Response Output
HTTP Header
Icon
Image File
Image File Detail
Inbound Network Connection AWS Topologies
Inbound Network Connection Topologies
Influence Thresholds
Interactions Capability
Invalid Parameter
Invite
Invite Collection
Item Quantity Output
Knowledge Article Version
Knowledge Article Version Collection
Knowledgeable People
Knowledgeable People Collection
Lightning Extension Information
Lightning Knowledge Article Version
Lightning Knowledge Article Version Collection
Like
Like Intent
Like Intents
Like Message Body
Like Page
Like Social Post Intent
Like Summary
Link Capability
Link Metadata
Link Metadata Collection
List Current Share Collection
List Share
List Timeline
List Share Category
List Share Collection
List View Column
List View Definition
List View Object
List View Record
List View Sort
Location Capacity Output
Location Output
Maintenance Information
Managed Content Associations
Managed Content Channel
Managed Content Channel Collection
Managed Content Channel Detail
Managed Content Channel Summary
Managed Content Channel Target Summary
Managed Content Collection Item
Managed Content Collection Item Type Summary
Managed Content Collection Items
Managed Content Date and Time Node Value
Managed Content Date Node Value
Managed Content Delivery Document
Managed Content Delivery Document Collection
Managed Content Delivery Document Summary
Managed Content Document
Managed Content Folder Search Result
Managed Content Folder Summary
Managed Content Language Summary
Managed Content Media Node Value
Managed Content Media Source Node Value
Managed Content Node Type
Managed Content Publish
Managed Content Reference
Managed Content Reference Summary
Managed Content Search Index
Managed Content Search Index Collection
Managed Content Search Result
Managed Content Search Result Collection
Managed Content Search Result Content Type
Managed Content Search Result Items Collection
Managed Content Space
Managed Content Space Folder
Managed Content Space Folder Detail
Managed Content Space Summary
Managed Content Text Node Value
Managed Content Type
Managed Content Type Searchable
Managed Content Type Searchable Collection
Managed Content Type Summary
Managed Content Unpublish
Managed Content User Summary
Managed Content Variant
Managed Content Variant Search Result
Managed Content Variant Status
Managed Content Version
Managed Content Version Collection
Managed Social Account
Managed Social Account Setup
Managed Social Account Setup Authentication
Managed Social Accounts
Managed Social Accounts Setup
Managed Topic
Managed Topic Collection
Markets
Media Reference
Media Reference Capability
Mention Completion
Mention Completion Page
Mention Validation
Mention Validations
Message
Message Collection
Message Segment: Entity Link
Message Segment: Field Change
Message Segment: Field Change Name
Message Segment: Field Change Value
Message Segment: Hashtag
Message Segment: Inline Image
Message Segment: Link
Message Segment: Markup Begin
Message Segment: Markup End
Message Segment: Mention
Message Segment: More Changes
Message Segment: Resource Link
Message Segment: Text
Messaging Channel
Messaging Channels
Microbatching Error Record Info
Microbatching Error Record Info Collection
Microbatching Error Record Info Request Body
Microbatching Error Resubmission
Microbatching Ingestion Output
Moderation Audit Record Count
Moderation Capability
Moderation Flag Item
Moderation Flags
Moderation Flags Collection
Motif
Multiple Async Output
Multiple Fulfillment Order Invoices Output
Multiple Fulfillment Order Output
Mute Capability
Mute Summary
Name Value Pair Output
Named Credential
Named Credential Callout Options
Named Credential List
Named Credential Parameter
Navigation Menu Item
Navigation Menu Item Collection
Navigation Menu Page Reference
Network Connection
Network Data Category
Network Data Category Group
Network Data Category Tree
New User Audience Criteria
Next Best Action Flow Action
Next Best Action Native Recommendation
Next Best Action Parameter
Next Best Action Recommendation
Next Best Action Recommendations
Notification
Notification App Setting
Notification App Settings Collection
Notification Collection
Notification Member
Notification Setting
Notification Settings Collection
Notification Status
OAuth Credential Auth URL
OAuth Provider
OAuth User
OCI Create Reservation Error Output
OCI Create Reservation Output
OCI Create Reservation Single Output
OCI Fulfill Reservation Error Output
OCI Fulfill Reservation Output
OCI Fulfill Reservation Single Output
OCI Future Inventory Output
OCI Get Inventory Availability Output
OCI Inventory Check Availability Output
OCI Inventory Levels Output
OCI Inventory Product Check Availability Output
OCI Inventory Product Output
OCI Inventory Record Output
OCI Location Availability Output
OCI Location Check Availability Output
OCI Location Group Availability Output
OCI Location Group Check Availability Output
OCI Location Group Levels Output
OCI Location Levels Output
OCI Publish Location Structure Output
OCI Publish Location Structure Status Output
OCI Release Reservation Error Output
OCI Release Reservation Output
OCI Release Reservation Single Output
OCI Transfer Reservation Error Output
OCI Transfer Reservation Output
OCI Transfer Reservation Single Output
OCI Upload Inventory Availability Output
OCI Upload Inventory Availability Status Output
Orchestration Instance
Orchestration Instance Collection
Orchestration Stage Instance
Orchestration Step Instance
Orchestration Work Item
Order Delivery Group Summary
Order Delivery Group Summary Collection
Order Delivery Group Summary Lookup Output
Order Delivery Method Lookup Output
Order Item Summary
Order Item Summary Adjustment Aggregates
Order Item Summary Adjustment Collection
Order Item Summary Adjustment List
Order Item Summary Collection
Order Item Summary Lookup Output
Order Item Summary Output
Order Item Summary Product
Order Quantities Output
Order Shipment
Order Shipment Collection
Order Shipment Item
Order Shipment Item Collection
Order Summary
Order Summary Adjustment
Order Summary Adjustment Aggregates
Order Summary Adjustment Aggregates Async Output
Order Summary Adjustment Collection
Order Summary Collection
Order Summary Graph Output
Order Summary Graphs Output
Order Summary Lookup Output
Order Summary Output
Order Summary Product Attribute
Order Summary Product Lookup Output
Order to Cart Failed Product
Order to Cart Result
Organization
Origin Capability
Out of Office
Outbound Network Connection AWS Topologies
Outbound Network Connection Topologies
Pardot Business Unit Context Item
Pardot Business Unit Context Output
Payment Authorization Output
Payment Group Output
Payment Method Details
Payment Method Output
Payment Method Tokenization Gateway Response Output
Payment Method Tokenization Output
Payment Output
Payment Token
Apple Pay Domain
Payment Intents
Payment Method Sets
Saved Payment Method Collection
Saved Payment Method Output
Phone Number
Photo
Pin Capability
Pinned Feed Element Collection
Platform Action
Platform Action Group
Poll Capability
Post Auth Gateway Response
Post Auth Output
Preserve Cart Output
Preview Cancel Output
Preview Cart To Exchange Order
Preview Return Output
Price Adjustment Schedule
Price Adjustment Tier
Pricing Result
Pricing Result Line Item
Priming Record
Priming Record Collection
Priming Records Stats
Priming Rule Error
Product Output
Product Attribute Info
Product Attribute Selection Info
Product Attribute Set
Product Attribute Set Info
Product Attribute Set Summary
Product Attribute Summary
Product Attributes to Product Entry
Product Cart Item
Product Cart Item Collection
Product Category
Product Category Detail
Product Category Detail Collection
Product Category Media
Product Category Media Group
Product Category Path
Product Child
Product Child Collection
Product Detail
Product Details Output
Product Entitlement
Product Expand
Product Image Group Output
Product Image Output
Product Import
Product List
Product Media
Product Media Group
Product Overview
Product Overview Collection
Product Price
Product Price Entry
Product Return Rate List
Product Return Rate
Product Search Facet
Product Search Facet Value
Product Search Image
Product Search
Product Search Product
Product Search Results
Product Search Suggestions Results
Product Selling Model
Product Summary
Product Summary Collection
Product Variant Output
Product Variation Attribute Output
Product Variation Attribute Value Output
Product Variation Info
Program Application Output
Promotion
Promotion Cart
Promotion Cart Adjustment Group
Promotion Cart Item
Promotion Cart Item Price Adjustment
Promotion Coupon
Promotion Evaluation
Promotion Price Adjustment
Promotion Product Evaluation
Promotion Target
Promotion Target Line Item
Purchase Quantity Rule
Question and Answers Capability
Question and Answers Suggestion Collection
Quick Text Preview Body
Quick Text Preview Body Part
Quick Text Runtime Body
Quip Content Document Link
Quip Linked Entity
Quip Related Records
Rank Average Distance Output
Read By
Read By Capability
Read By Collection
Recommendation Object
Recommendation Reaction
Recommendation Reaction Collection
Recommendations Capability
Recommended Object
Record Capability
Record Field
Record Field: Blank
Record Field: Compound
Record Field: Currency
Record Field: Date
Record Field: Percent
Record Field: Picklist
Record Field: Reference
Record Field: Reference with Date
Record Snapshot
Record Snapshot Capability
Record Summary
Record Summary List
Record View
Record View Section
Recordset Filter Criteria
Recordset Filter Criteria Collection
Reference
Referenced Refund Service Output
Refund Gateway Response Output
Refund Output
Refund Service Output
Related Feed Post
Related Feed Post Collection
Register Guest Buyer
Related Question
Release Held FO Capacity Output
Release Held FO Capacity Response Output
Reply Recommendations Metric
Reply Recommendations Metrics
Reply Social Post Intent
Reply Social Post Intents
Repository Directory Entry Collection
Repository File Detail
Repository File Summary
Repository Folder Detail
Repository Folder Item
Repository Folder Items Collection
Repository Folder Summary
Repository Group Summary
Repository Permission Type Collection
Repository User Summary
Reputation
Reputation Level
Request Header
Return Items Output
Return Order Item Split Line Output
Return Order Output
Sale Gateway Response
Sale Output
Scheduled Custom Recommendation
Scheduled Custom Recommendation Collection
Scope
Searchable Attribute
Searchable Attributes Collection
Search Category
Search Product Setting Collection Output
Search Product Setting Output
Include Search Rule
Include Search Rule Collection
Search Suggestion
Service Appointment Output
Service Appointment Result
Service Catalog Item
Service Catalog Item Collection
Service Territories List Result
Service Territories Output
Service Territories Result
Session Context
Share Captured Activity Result
Shifts from Pattern
Shift Pattern Error
Social Account
Social Account Relationship
Social Customer Service Configuration
Social Customer Service Message Type Settings
Social Customer Service Provider Settings
Social Post Capability
Social Post Intents
Social Post Mass Approval
Social Post Status
Sort Rule
Sort Rules Collection
Stamp
Status Capability
Store Taxes Info
Strategy Trace
Strategy Trace Node
Submit Cancel Output
Submit Cart to Exchange Order
Submit Return Output
Subscription
Subscription Page
Subscription Term Rule
Supported Emoji
Survey Description Output
Survey Detail Output
Survey Email
Survey NPS Question Output
Survey Question Output
Survey Question Page Output
Survey Selection Question Choice Output
Survey Response Output
Survey Selection Question Output
Survey Short-Text Question Output
Survey Text Question Output
Survey Thank You Page Output
Survey URL Buttons Output
Taxes Info
Taxes Info Container
Target
Target Collection
Tax Adjustment
Terms of Service
Text Classifications
Text Classifications Bulk Results
Text Classifications Result
Text Classifications Result with ID
Activity Timeline
Time Zone
Topic
Topic Collection
Topic Endorsement
Topic Endorsement Collection
Topic Endorsement Summary
Topic Images
Topic Opt Out
Topic Opt Out Collection
Topic Suggestion
Topic Suggestion Collection
Topic Summary
Topics Capability
Topics People Are Knowledgeable About
Topics People Are Knowledgeable About Collection
Tracked Change Bundle Capability
Tracked Changes Capability
Unauthenticated User
Up Down Vote Capability
Upvote Summary
User Activities Job
User Activity Collection
User Capabilities
User Chatter Settings
User Detail
User Group Detail Collection
User Group Page
User Mission
User Mission Activities Job
User Mission Activity
User Mission Activity Collection
User Mission Activity Status
User Page
User Profile
User Profile Tab
User Reference Collection
User Settings
User Status
User Summary
Verified Capability
Vote
Vote Collection
Waitlist Analytics
Waitlist Check In
Waitlist Check In Result
Waitlist Details
Waitlist List Result
Waitlist Participant Details
Waitlist Participant Result
Waitlist Result
Waitlist Service Resource
Waitlist Work Type Group
Wishlist
Wishlist Item
Wishlist Item Collection
Wishlist Summaries
Wishlist Summary
Wishlist to Cart Result
Workspace Permission
Wrapped Map
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Einstein Prompt Template Generations

Generated response from the specified LLM provider and resolved prompt template text.
Property Name Type Description Filter Group and Version Available Version
generations Einstein LLM Generation Item List of generated responses from the LLM provider. Small, 60.0 60.0
parameters Wrapped Map Map of parameters and values for the LLM provider parameters. Medium, 60.0 60.0
prompt String Prompt template text with resolved inputs. Medium, 60.0 60.0
promptTemplate​DevName String Developer name or ID of the prompt template record. Medium, 60.0 60.0
requestId String ID of the generation request sent to the LLM provider. Small, 60.0 60.0