Connect REST API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Connect REST API Developer Guide
Introduction
When to Use Connect REST API
Connect REST API Architecture
Connect REST API Limits
Build the Resource URL
Send HTTP Requests
HTTP Request Flow and a Response Body
Inputs and Binary File Upload Examples
Wildcards
Specify Response Sizes
Response Body Encoding
Status Codes and Error Responses
OAuth and Connect REST API
Perform Cross-Origin Requests from Web Browsers
Connect REST API Release Notes
API End-of-Life Policy
Quick Start
Work with Features
Examples
Resources
Chatter Resources
Request Bodies
Response Bodies
Appendices
PDF

Connect REST API Architecture

To use Connect REST API, understand a few characteristics of its architecture, like how to authenticate, and which data formats it supports.
Authentication
Connect REST API uses OAuth 2.0.
Salesforce is accessed securely using HTTPS.
CORS (Cross-Origin Resource Scripting)
Cross-Origin Resource Sharing (CORS) allows web browsers to request resources from other origins. For example, using CORS, the JavaScript for a web application at https://www.example.com can request a resource from https://www.salesforce.com. To allow access to supported Salesforce APIs, Apex REST resources, and Lightning Out from JavaScript code in a web browser, add the requesting origin to your Salesforce CORS allowlist. See Perform Cross-Origin Requests from Web Browsers.
Default HTML entity encoding
Responses are minimally HTML entity-encoded by default.

Clients can request raw (unencoded) output. Set the X-Chatter-Entity-Encoding HTTP header in a request to false.

For more information, see Response Body Encoding.

JSON and XML support
The JavaScript Object Notation (JSON) format is supported with UTF-8. Date-time information is in ISO 8601 format.
XML serialization is similar to SOAP API. XML requests are supported in UTF-8 and UTF-16, and XML responses are provided in UTF-8.
Responses are in JSON format by default. To specify XML, use the HTTP header Accept: application/xml. (To specify JSON, use Accept: application/json.)
You can append either .json or .xml to the URI of any resource to specify how the return is formatted. For example, /chatter/feeds/filter/me/001/feed-elements.xml.

Not all features support XML.

Note

Localized names and times
Connect REST API localizes both the names and datetimes to the locale setting of the user. Users set their locale in their personal information. If the user hasn’t set their locale, Connect REST API uses the default locale for the organization.
Clients can use any locale available in the organization to override the default locale. To override the locale for any API request, use the Accept-Language HTTP header.
For orgs created in Summer ’23 and later, the language specified in the Accept-Language HTTP header must be the same as specified in a language query parameter.

ISO 8601 dates are always in GMT.

Note

Salesforce ID length
Salesforce IDs in response bodies are always 18-character IDs. In request bodies, you can use either 15-character IDs or 18-character IDs.
UI Themes
Clients can use the X-Connect-Theme HTTP header to specify a UI theme for any API request. There are two themes, each with their own set of motif icons: Classic and Salesforce1. Theme names are case-sensitive.
Method overriding
To override an HTTP method if you use an HTTP library that doesn’t allow overriding or setting an arbitrary HTTP method name, use the request parameter _HttpMethod.
POST https://instance_name/services/data/v64.0/chatter/
/chatter/users/me/conversations/03MD0000000008KMAQ
?_HttpMethod=PATCH&read=true

The _HttpMethod parameter is case-sensitive. Use the correct case for all values.

Note