{ "opencollection": "1.0.0", "info": { "name": "Salesforce", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "{DefaultParameterValue}{DefaultParameterValue}/services/oauth2/authorize", "credentials": { "clientId": "{{clientId}}" } } }, "items": [ { "info": { "name": "Initialize", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Registration - Initialize", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/services/auth/headless/init/registration", "body": { "type": "json", "data": "{}" } }, "docs": "Submits the registration data to the init/registration endpoint and returns a request identifier. At the same time, an OTP is sent out to the end users via email or sms. Registration data is passed in the request body, and is formatted with JSON, with 5 keys: `userdata`, `customdata`, `password`, `recaptcha`, and `verificationmethod`. The first two keys are JSON structures, and the last 3 keys are strings.\n\nThis request returns JSON, and includes an identifier (request identifier)." }, { "info": { "name": "Salesforce Forgot Password - Initialize", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/services/auth/headless/forgot_password", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Forgot Password - Initialize" }, { "info": { "name": "Salesforce Passwordless Login - Initialize", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/services/auth/headless/init/passwordless/login", "body": { "type": "json", "data": "{}" } }, "docs": "Submits the passwordless login data to the init/passwordless/login endpoint and returns a request identifier. At the same time, an OTP is sent out to the end users via email or sms. Passwordless login data is passed in the request body, and is formatted with JSON, with 3 keys: `username`, `recaptcha`, and `verificationmethod`. All 3 keys are strings.\n\nThis request returns JSON, and includes an identifier (request identifier)." } ] }, { "info": { "name": "Agent", "type": "folder" }, "items": [ { "info": { "name": "Salesforce User Agent Flow", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/services/oauth2/authorize", "params": [ { "name": "response_type", "value": "example_value", "type": "query" }, { "name": "client_id", "value": "500123", "type": "query" }, { "name": "redirect_uri", "value": "example_value", "type": "query" }, { "name": "display", "value": "example_value", "type": "query" }, { "name": "login_hint", "value": "example_value", "type": "query" }, { "name": "nonce", "value": "example_value", "type": "query" } ] }, "docs": "Salesforce User Agent Flow" }, { "info": { "name": "Salesforce Run Agent Test", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/einstein/ai-evaluations/runs", "body": { "type": "json", "data": "{}" } }, "docs": "Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm))." } ] }, { "info": { "name": "Authorize", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Registration - Authorize", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/services/oauth2/authorize", "headers": [ { "name": "Auth-Request-Type", "value": "example_value" }, { "name": "Auth-Verification-Type", "value": "example_value" }, { "name": "Authorization", "value": "example_value" } ], "body": { "type": "form-urlencoded", "data": [ { "name": "response_type", "value": "" }, { "name": "client_id", "value": "" }, { "name": "redirect_uri", "value": "" }, { "name": "scope", "value": "" } ] } }, "docs": "After you send your registration data to initialize, this request allows you to process that registration data, and as a part of this request you also verify the users email or sms number. The request itself is a authorization call for the Code and Credential flow. It includes 3 specific headers: `Auth-Request-Type` which is set to `user-registration`, `Auth-Verification-Type` which is set to email or sms, and an Authorization Basic header, which is the base 64 encoded result of `identifier:otp`" } ] }, { "info": { "name": "Exchange", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Registration - Token Exchange", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/services/oauth2/token", "body": { "type": "form-urlencoded", "data": [ { "name": "code", "value": "" }, { "name": "grant_type", "value": "" }, { "name": "client_id", "value": "" }, { "name": "redirect_uri", "value": "" } ] } }, "docs": "This exchanges the auth code returned in the Authorize Request for an access token and refresh token. This follows the standard Auth Code flow/Webserver Code Flow pattern. The Code is the return form the Authorization call." } ] }, { "info": { "name": "Get", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get User Info", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/services/oauth2/userinfo", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "Content-Type", "value": "example_value" } ] }, "docs": "This requests uses an access token to get user information from Salesforce using the standard `/userinfo` endpoint." }, { "info": { "name": "Salesforce Get Job Info Query", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/jobs/query/" }, "docs": "Salesforce Get Job Info Query" }, { "info": { "name": "Salesforce Get Job Query Result", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/jobs/query//results", "headers": [ { "name": "Content-Type", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ] }, "docs": "Salesforce Get Job Query Result" }, { "info": { "name": "Salesforce Get Parallel Results for a Query Job", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/jobs/query//resultPages", "headers": [ { "name": "Content-Type", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ] }, "docs": "Retrieves a set of up to 5 job results pages for parallel download." }, { "info": { "name": "Salesforce Get Job Info", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/jobs/ingest/" }, "docs": "Salesforce Get Job Info" }, { "info": { "name": "Salesforce Get Job Successful Record Results", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/jobs/ingest//successfulResults" }, "docs": "Salesforce Get Job Successful Record Results" }, { "info": { "name": "Salesforce Get Job Unprocessed Record Results", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/jobs/ingest//unprocessedrecords" }, "docs": "Salesforce Get Job Unprocessed Record Results" }, { "info": { "name": "Salesforce Get Table", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/decision-table/definitions/:decisionTableId", "params": [ { "name": "decisionTableId", "value": "500123", "type": "path", "description": "Decision Table Id" } ] }, "docs": "# Decision Table Definitions ( GET)\n\nGet details of a decision table definition.\n\nResource\n\n```\n/connect/business-rules/decision-table/definitions/${decisionTableId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-table/definitions/0lDxx00000002Ur\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nGET\n\nResponse body for GET\n\n[Decision Table Output](https://developer.salesforce.com/docs/atlas.en-us.industries_re" }, { "info": { "name": "Salesforce Get Test Status", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/einstein/ai-evaluations/runs/:runId", "params": [ { "name": "runId", "value": "500123", "type": "path", "description": "Evaluation ID" } ] }, "docs": "Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm))." }, { "info": { "name": "Salesforce Get Test Results", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/einstein/ai-evaluations/runs/:runId/results", "params": [ { "name": "runId", "value": "500123", "type": "path", "description": "Evaluation ID" } ] }, "docs": "Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm))." }, { "info": { "name": "Salesforce Integration Procedure Invocation Using Get", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/apexrest/:NAMESPACE/v1/integrationprocedure/:TYPE_SUBTYPE", "params": [ { "name": "NAMESPACE", "value": "example_value", "type": "path", "description": "The namespace: `omnistudio`, `vlocity_ins`, `vlocity_cmt`, or `vlocity_ps`" }, { "name": "TYPE_SUBTYPE", "value": "example_value", "type": "path", "description": "Type and SubType of the Integration Procedure separated by an underscore." } ] }, "docs": "Salesforce Integration Procedure Invocation Using Get" }, { "info": { "name": "Salesforce Sobject Get Deleted", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/deleted", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "start", "value": "example_value", "type": "query" }, { "name": "end", "value": "example_value", "type": "query" }, { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Retrieves the list of individual records that have been deleted within the given timespan for the specified object. SObject Get Deleted is available in API version 29.0 and later.\n\nThis resource is commonly used in data replication applications. Note the following considerations:\nDeleted records are written to a delete log which this resource accesses. A background process that runs every two hours purges records that have been in an organization's delete log for more than two hours if the numbe" }, { "info": { "name": "Salesforce Sobject Get Updated", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/updated", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "start", "value": "example_value", "type": "query" }, { "name": "end", "value": "example_value", "type": "query" }, { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Retrieves the list of individual records that have been updated (added or changed) within the given timespan for the specified object. SObject Get Updated is available in API version 29.0 and later.\n\nThis resource is commonly used in data replication applications. Note the following considerations:\nResults are returned for no more than 30 days previous to the day the call is executed.\nYour client application can replicate any objects to which it has sufficient permissions. For example, to replic" }, { "info": { "name": "Salesforce Get List Views for an Object", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/list-info/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "API name of a UI API supported object." } ] }, "docs": "Get list views associated with an object." }, { "info": { "name": "Salesforce Get List View Records by Id", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/list-records/:LIST_VIEW_ID", "params": [ { "name": "LIST_VIEW_ID", "value": "500123", "type": "path", "description": "The ID of a list view." } ] }, "docs": "Get record data for a list view by list view ID using URL parameters." }, { "info": { "name": "Salesforce Get List View Records by Api Name", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/list-records/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "API name of a UI API supported object." }, { "name": "LIST_VIEW_API_NAME", "value": "example_value", "type": "path", "description": "API name of a list view, such as AllAccounts, __Recent, or __SearchResult." } ] }, "docs": "Get record data for a list view by list view API name using URL parameters." }, { "info": { "name": "Salesforce Get List View Records", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/ui-api/list-records/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "API name of the UI API supported object." }, { "name": "LIST_VIEW_API_NAME", "value": "example_value", "type": "path", "description": "API name of a list view." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get record data for a list view using a request body." }, { "info": { "name": "Salesforce Get List View Metadata by Id", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/list-info/:LIST_VIEW_ID", "params": [ { "name": "LIST_VIEW_ID", "value": "500123", "type": "path", "description": "The ID of a list view." } ] }, "docs": "Get list view metadata by list view ID using URL parameters." }, { "info": { "name": "Salesforce Get List View Metadata by Api Name", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "API name of the UI API supported object." }, { "name": "LIST_VIEW_API_NAME", "value": "example_value", "type": "path", "description": "API name of a list view, such as AllAccounts, __Recent, or __SearchResult." } ] }, "docs": "Get list view metadata by list view API name using URL parameters." }, { "info": { "name": "Salesforce Get Sandbox", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID", "params": [ { "name": "SANDBOX_INFO_ID", "value": "500123", "type": "path" } ] }, "docs": "Retrieves a sandbox record." }, { "info": { "name": "Salesforce Get Tooling Metadata Sobject", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Salesforce Get Tooling Metadata Sobject" }, { "info": { "name": "Salesforce Get Record Layout Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/layout/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Get metadata about page layouts for the specified object type." }, { "info": { "name": "Salesforce Get Object Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/object-info/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme." }, { "info": { "name": "Salesforce Get a Record", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/records/:RECORD_ID", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path" } ] }, "docs": "Get a record’s data." }, { "info": { "name": "Salesforce Get Favorites", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/favorites" }, "docs": "Get all of a user’s favorites." }, { "info": { "name": "Salesforce Get Personalized Navigation Items", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/apps/:APP_ID/user-nav-items", "params": [ { "name": "APP_ID", "value": "500123", "type": "path", "description": "Application ID" } ] }, "docs": "Get a user’s personalized navigation items (tabs)." } ] }, { "info": { "name": "Revoke", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Revoke Token", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/services/oauth2/revoke", "body": { "type": "form-urlencoded", "data": [ { "name": "token", "value": "" } ] } }, "docs": "This calls the standard revoke endpoint, passing in your access token. This endpoint should be called as part of your logout process to invalidate the access and refresh token. " } ] }, { "info": { "name": "Oauth", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Oauth Usage", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/services/data/v64.0/apps/oauth/usage", "headers": [ { "name": "Authorization", "value": "example_value" } ], "params": [ { "name": "page", "value": "10", "type": "query", "description": "Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of usage entries per page. Defaults to 100." } ] }, "docs": "Lists all the external client apps for the current org. See [OAuth Usage](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage.htm)." }, { "info": { "name": "Salesforce Oauth User Tokens Revoke", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/services/data/v64.0/apps/oauth/usage///tokens", "headers": [ { "name": "Authorization", "value": "example_value" } ] }, "docs": "Revokes all tokens for a user of the external client app. See [Refresh Token by User and App](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_user_id_tokens.htm)." }, { "info": { "name": "Salesforce Oauth Tokens Revoke", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/services/data/v64.0/apps/oauth/usage//tokens", "headers": [ { "name": "Authorization", "value": "example_value" } ] }, "docs": "Revokes all tokens available for the external client app. See [Refresh Token by App ID](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_tokens.htm)." }, { "info": { "name": "Salesforce Oauth Token Revoke", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/services/data/v64.0/apps/oauth/usage/tokens/", "headers": [ { "name": "Authorization", "value": "example_value" } ] }, "docs": "Revokes one token. See [OAuth Refresh Token](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_tokens_token_id.htm)." } ] }, { "info": { "name": "Applications", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Oauth App Users", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/services/data/v64.0/apps/oauth/usage//users", "headers": [ { "name": "Authorization", "value": "example_value" } ], "params": [ { "name": "page", "value": "10", "type": "query", "description": "Page number for the usage information. Defaults to 0." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of usage entries per page. Defaults to 100." } ] }, "docs": "Lists all users for the external client app indicated by the app ID. See [OAuth Users by App ID](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_users.htm)." }, { "info": { "name": "Salesforce Oauth App Users Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/services/data/v64.0/apps/oauth/usage///tokens", "headers": [ { "name": "Authorization", "value": "example_value" } ] }, "docs": "Lists all tokens for a user of the external client app. See [Refresh Token by User and App](https://developer.salesforce.com/docs/atlas.en-us.246.0.chatterapi.meta/chatterapi/connect_resources_usage_app_id_user_id_tokens.htm)." }, { "info": { "name": "Salesforce Lightning Usage by App Type", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/LightningUsageByAppTypeMetrics", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Return the total number of Lightning Experience and Salesforce Mobile users.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyapptypemetrics.htm" }, { "info": { "name": "Salesforce Get Apps", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/apps", "params": [ { "name": "formFactor", "value": "example_value", "type": "query", "description": "The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)" } ] }, "docs": "Get metadata for all the apps a user has access to. Metadata for the selected app includes tabs on the app’s navigation bar. Metadata for other apps doesn’t include tabs on the navigation bar." }, { "info": { "name": "Salesforce Get an App", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/apps/:APP_ID", "params": [ { "name": "formFactor", "value": "example_value", "type": "query", "description": "The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)" }, { "name": "APP_ID", "value": "500123", "type": "path", "description": "Application ID" } ] }, "docs": "Get metadata about an app." }, { "info": { "name": "Salesforce Update Last Selected App", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/ui-api/apps/:APP_ID", "params": [ { "name": "formFactor", "value": "example_value", "type": "query", "description": "The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)" }, { "name": "APP_ID", "value": "500123", "type": "path", "description": "Application ID" } ] }, "docs": "Returns metadata for an app, and saves an app as the last selected for a user." }, { "info": { "name": "Salesforce Get Last Selected App", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/apps/selected", "params": [ { "name": "formFactor", "value": "example_value", "type": "query", "description": "The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)" } ] }, "docs": "Retrieves the app the current user last selected or the app the user sees by default." } ] }, { "info": { "name": "Collections", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Collections", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/services/data/v64.0/apps/oauth/credentials/", "headers": [ { "name": "Authorization", "value": "example_value" } ] }, "docs": "Returns credentials for all consumers associated with an external client app. See [OAuth Credentials by App ID](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_credentials_by_app_id.htm)." }, { "info": { "name": "Salesforce Sobject Collections Create", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/composite/sobjects", "body": { "type": "json", "data": "{}" } }, "docs": "Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips between the client and server. This resource is available in API version 42.0 and later.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm" }, { "info": { "name": "Salesforce Sobject Collections Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/composite/sobjects", "body": { "type": "json", "data": "{}" } }, "docs": "Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips between the client and server. This resource is available in API version 42.0 and later.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm" }, { "info": { "name": "Salesforce Sobject Collections Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/composite/sobjects", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "ids", "value": "example_value", "type": "query" }, { "name": "allOrNone", "value": "true", "type": "query" } ] }, "docs": "Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips between the client and server. This resource is available in API version 42.0 and later.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm" }, { "info": { "name": "Salesforce Sobject Collections Retrieve", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/composite/sobjects/:SOBJECT_API_NAME", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "ids", "value": "example_value", "type": "query" }, { "name": "fields", "value": "example_value", "type": "query" }, { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips between the client and server. This resource is available in API version 42.0 and later.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm" }, { "info": { "name": "Salesforce Sobject Collections Upsert", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/composite/sobjects/:SOBJECT_API_NAME/:FIELD_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "FIELD_NAME", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use a PATCH request with sObject Collections to either create or update (upsert) up to 200 records based on an external ID field. This method returns a list of UpsertResult objects. You can choose whether to roll back the entire request when an error occurs. This request is available in API version 46 and later.\n\n[https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_upsert.htm](https://developer.salesforce.com/docs/atlas.en-us.api_rest" } ] }, { "info": { "name": "Resources", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Resources", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/services/data/v64.0/apps/oauth/credentials//", "headers": [ { "name": "Authorization", "value": "example_value" } ], "params": [ { "name": "part", "value": "example_value", "type": "query", "description": "Key, Secret, or KeyAndSecret" } ] }, "docs": "Returns credentials for a specific consumer. Use parameters to determine whether the request should return the key, the secret, or both key and secret. See [OAuth Credentials by Consumer ID](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_credentials_by_app_and_consumer_id.htm)." }, { "info": { "name": "Salesforce Resources by Version", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Lists available resources for the specified API version, including resource name and URI." } ] }, { "info": { "name": "Connect", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Openid Connect Discovery Endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/.well-known/openid-configuration" }, "docs": "Salesforce Openid Connect Discovery Endpoint" }, { "info": { "name": "Salesforce Openid Connect Token Introspection Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/services/oauth2/introspect", "headers": [ { "name": "Content-Type", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "body": { "type": "form-urlencoded", "data": [ { "name": "token", "value": "" }, { "name": "token_type_hint", "value": "" }, { "name": "client_id", "value": "" }, { "name": "client_secret", "value": "" } ] } }, "docs": "Salesforce Openid Connect Token Introspection Endpoint" } ] }, { "info": { "name": "Authentication", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Authentication Configuration Endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/.well-known/auth-configuration" }, "docs": "Salesforce Authentication Configuration Endpoint" } ] }, { "info": { "name": "Client", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Openid Connect Dynamic Client Registration Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/services/oauth2/register", "headers": [ { "name": "Accept", "value": "example_value" }, { "name": "Authorization", "value": "example_value" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Openid Connect Dynamic Client Registration Endpoint" } ] }, { "info": { "name": "Keys", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Keys", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/id/keys" }, "docs": "Salesforce Keys" } ] }, { "info": { "name": "Identifiers", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Id Token", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com//", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Salesforce Id Token" } ] }, { "info": { "name": "Abort", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Abort a Job Query", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/jobs/query/", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Abort a Job Query" }, { "info": { "name": "Salesforce Close or Abort a Job", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/jobs/ingest/", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Close or Abort a Job" } ] }, { "info": { "name": "Deletes", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Delete Job Query", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/jobs/query/" }, "docs": "Salesforce Delete Job Query" }, { "info": { "name": "Salesforce Delete Job", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/jobs/ingest/" }, "docs": "Salesforce Delete Job" }, { "info": { "name": "Salesforce File Information - Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/connect/files/:FILE_ID", "params": [ { "name": "FILE_ID", "value": "500123", "type": "path" } ] }, "docs": "Get information about a specified file, including references to external files. Upload a new version of an existing file, including references to external files. Rename a file, move a file to a different folder, and delete a file.\nTo upload a new version of an existing file, make a POST request. Upload the new version as a binary part in a multipart/form-data request. See Uploading Binary Files. To upload a new file to the Files home, use /connect/files/users/me.Get information about a specified" }, { "info": { "name": "Salesforce Feed Element - Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/chatter/feed-elements/:FEED_ELEMENT_ID", "params": [ { "name": "FEED_ELEMENT_ID", "value": "500123", "type": "path" } ] }, "docs": "Access, edit, or delete a feed element. Feed items are the only type of feed element that can be edited.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_feed_element_specific.htm" }, { "info": { "name": "Salesforce Delete Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/chatter/subscriptions/:SUBSCRIPTION_ID", "params": [ { "name": "SUBSCRIPTION_ID", "value": "500123", "type": "path" } ] }, "docs": "Information about the specified subscription. Also used to delete a subscription, for example, to unfollow a record or a topic.\nA subscription ID is returned as part of the response body for follower and following resources, for example, /records/recordId/followers. In addition, subscriptions IDs are also returned in many summary response bodies, such as group summary or user summary.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_subscriptions.ht" }, { "info": { "name": "Salesforce Expression Set Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/expression-set/:expressionSetId", "params": [ { "name": "expressionSetId", "value": "500123", "type": "path", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] }, "docs": "# Expression Set Retrieve and Delete (DELETE, GET)\n\nEndpoints to read, and delete expression set.Resource\n\n```\n/connect/business-rules/expression-set/${expressionSetId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect\n /business-rules/expressionSet/$11Oxx0000006PcLEAU\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nDELETE, GET\n\nRequest body for GET\n\nRoot XML tag\n\nJSON example\n\n```\n{\n \"name\": \"CTX Mapping ES\",\n \"apiName\"" }, { "info": { "name": "Salesforce Delete Table", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/decision-table/definitions/:decisionTableId", "params": [ { "name": "decisionTableId", "value": "500123", "type": "path", "description": "Decision Table Id" } ] }, "docs": "# Decision Table Definitions ( DELETE)\n\nDelete a decision table definition associated with a decision table.\n\nResource\n\n```\n/connect/business-rules/decision-table/definitions/${decisionTableId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-table/definitions/0lDxx00000002Ur\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nDELETE\n\nResponse body for DELETE\n\n[Decision Table Output](https://developer.salesforce." }, { "info": { "name": "Salesforce Delete Event Relay", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/EventRelayConfig/:EVENT_RELAY_CONFIG_ID", "params": [ { "name": "EVENT_RELAY_CONFIG_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Delete Event Relay" }, { "info": { "name": "Salesforce Delete Managed Event Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/ManagedEventSubscription/:managedEventSubscriptionId", "params": [ { "name": "managedEventSubscriptionId", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Delete Managed Event Subscription" }, { "info": { "name": "Salesforce Sobject Rows Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/:RECORD_ID", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "RECORD_ID", "value": "500123", "type": "path" } ] }, "docs": "Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records." }, { "info": { "name": "Salesforce Delete Sandbox", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID", "params": [ { "name": "SANDBOX_INFO_ID", "value": "500123", "type": "path" } ] }, "docs": "Deletes a sandbox." }, { "info": { "name": "Salesforce Delete a Record", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/ui-api/records/:RECORD_ID", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" } ] }, "docs": "Update a record's data.\nUser Interface API enforces Salesforce validation rules. If a validation rule fails, the response is an Error with Output.\n\nWhen you make a PATCH request to update a record, make sure that the record hasn’t changed since the user started editing it. To find out whether it’s safe to save a record, pass the If-Modified-Since HTTP header in the request.\n\nAs of API version 43.0, if you pass read-only fields in a request body, the response is an Error with Output." }, { "info": { "name": "Salesforce Delete a Favorite", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/ui-api/favorites/:FAVORITE_ID", "params": [ { "name": "FAVORITE_ID", "value": "500123", "type": "path", "description": "The ID of a favorite" } ] }, "docs": "Get a favorite." } ] }, { "info": { "name": "All", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get All Query Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/jobs/query", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "isPkChunkingEnabled", "value": "true", "type": "query", "description": "If set to true, the request only returns information about jobs where PK Chunking is enabled" }, { "name": "jobType", "value": "example_value", "type": "query", "description": "BigObjectIngest Classic V2Query" }, { "name": "concurrencyMode", "value": "example_value", "type": "query", "description": "serial parallel" }, { "name": "queryLocator", "value": "example_value", "type": "query", "description": "use the value from the nextRecordsUrl from the previous set" } ] }, "docs": "Salesforce Get All Query Jobs" }, { "info": { "name": "Salesforce Get All Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/jobs/ingest" }, "docs": "Salesforce Get All Jobs" }, { "info": { "name": "Salesforce Get Values for All Picklist Fields of a Record Type", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/object-info/:SOBJECT_API_NAME/picklist-values/:RECORD_TYPE_ID", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "Object API Name" }, { "name": "RECORD_TYPE_ID", "value": "500123", "type": "path", "description": "Record type Id. Use `012000000000000AAA` as default when there are no custom record types." } ] }, "docs": "Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme." }, { "info": { "name": "Salesforce Get All Navigation Items", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/nav-items" }, "docs": "Gets all navigation items (tabs) that the user has access to." } ] }, { "info": { "name": "Create", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Successful Create Job Query", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/jobs/query", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Successful Create Job Query" }, { "info": { "name": "Salesforce Create Job", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/jobs/ingest", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Create Job" }, { "info": { "name": "Salesforce Create Credential", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/named-credentials/credential", "body": { "type": "json", "data": "{}" } }, "docs": "Create a credential." }, { "info": { "name": "Salesforce Create External Credential", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/named-credentials/external-credentials", "body": { "type": "json", "data": "{}" } }, "docs": "Create an external credential." }, { "info": { "name": "Salesforce Create Named Credential", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/named-credentials/named-credential-setup", "body": { "type": "json", "data": "{}" } }, "docs": "Create a named credential." }, { "info": { "name": "Salesforce Create Named Credential1", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/NamedCredential", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Create Named Credential1" }, { "info": { "name": "Salesforce Create Table", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/decision-table/definitions", "body": { "type": "json", "data": "{}" } }, "docs": "# Decision Table Definitions (POST)\n\nCreate a decision table definition. A decision table definition contains all the details required to create a decision table.Resource\n\n```\n/connect/business-rules/decision-table/definitions\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-table/definitions\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nJSON example for a single object source\n\n```\n{\n \"setupName\":\"P" }, { "info": { "name": "Salesforce Create Gifts", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/fundraising/gifts", "body": { "type": "json", "data": "{}" } }, "docs": "Create gift transactions with related new or matched donor, optional transaction designations, and payment instrument metadata. Supports custom fields for the donor account and gift transaction.\n\n## Required Attributes:\n\n- donor.donorType (\"individual\" or \"organization\")\n \n- donor.lastName || donor.organizationName\n \n- gift.amount\n \n- gift.receivedDate\n \n- git.status\n \n- paymentInstrument.type\n \n\nAll other attributes are optional can be left as an empty string or just removed f" }, { "info": { "name": "Salesforce Create Commitments", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/fundraising/commitments", "body": { "type": "json", "data": "{}" } }, "docs": "Create gift transactions with related new or matched donors, optional transaction designations, and payment instrument metadata. Supports custom fields for the donor account and gift transaction.\n\n## Required Attributes:\n\n- commitments.amount\n \n- commitments.transactionPeriod\n \n- commitments.startDate\n \n- donor.donorType (\"individual\" or \"organization\")\n \n- donor.lastName\n \n- donor.organization\n \n- paymentinstrument.type\n \n\nAll other attributes are optional can be left as an" }, { "info": { "name": "Salesforce Create Event Relay", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/EventRelayConfig", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Create Event Relay" }, { "info": { "name": "Salesforce Create Managed Event Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/ManagedEventSubscription", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Create Managed Event Subscription" }, { "info": { "name": "Salesforce Sobject Create", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME", "headers": [ { "name": "Authorization", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "SObject API name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Sobject Create" }, { "info": { "name": "Salesforce Create Payment Method", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/commerce/payments/payment-methods", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Create Payment Method" }, { "info": { "name": "Salesforce Create or Update Quote", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/commerce/quotes/actions/place", "body": { "type": "json", "data": "{}" } }, "docs": "This example creates a quote for the following products.\n\n- 5 Virtual Routers sold on a 1-year termed subscription at $35/item\n- 1 Bronze Service Level Agreement sold on an evergreen subscription at $10/month\n \n\nSee [place quote](https://developer.salesforce.com/docs/revenue/subscription-management/references/quotes?meta=Create+or+update+a+quote+with+place+quote)." }, { "info": { "name": "Salesforce Create Order From Quote", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/actions/standard/createOrderFromQuote", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Create Order From Quote" }, { "info": { "name": "Salesforce Create a Record", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/ui-api/records", "body": { "type": "json", "data": "{}" } }, "docs": "Create a record. First, make a request to the Clone Record Default or Create Record Default resources to get the default metadata and data for the record.\nAs of API version 43.0, if you pass read-only fields in a request body, the response is an Error with Output." }, { "info": { "name": "Salesforce Get Default Values to Create a Record", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/record-defaults/create/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "sObject API name" } ] }, "docs": "Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.\nThe response contains the default field values for the Full layout type for a new record of the object type specified in .\n\nIt also contains the corresponding layout for create mode. In the Salesforce user interface, an admin with “Customize Application” permission can mark a field as re" }, { "info": { "name": "Salesforce Create a Favorite", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/ui-api/favorites", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Favorite" } ] }, { "info": { "name": "Bulk", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Bulk Create Job", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/async/64.0/job", "headers": [ { "name": "X-SFDC-Session", "value": "example_value" }, { "name": "charset", "value": "example_value" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Bulk Create Job" }, { "info": { "name": "Salesforce Bulk Spec", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/async/64.0/job//spec", "headers": [ { "name": "X-SFDC-Session", "value": "example_value" }, { "name": "charset", "value": "example_value" }, { "name": "Accept-Encoding", "value": "example_value" }, { "name": "Content-Encoding", "value": "example_value" } ] }, "docs": "Salesforce Bulk Spec" }, { "info": { "name": "Salesforce Bulk Close Job", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/async/64.0/job/", "headers": [ { "name": "X-SFDC-Session", "value": "example_value" }, { "name": "charset", "value": "example_value" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Bulk Close Job" } ] }, { "info": { "name": "Batch", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Bulk Check Batch Status", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/async/64.0/job//batch", "headers": [ { "name": "X-SFDC-Session", "value": "example_value" }, { "name": "Accept-Encoding", "value": "example_value" }, { "name": "Content-Encoding", "value": "example_value" } ] }, "docs": "Salesforce Bulk Check Batch Status" }, { "info": { "name": "Salesforce Bulk Create Batch", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/async/64.0/job//batch", "headers": [ { "name": "X-SFDC-Session", "value": "example_value" }, { "name": "Content-Type", "value": "example_value" }, { "name": "charset", "value": "example_value" } ], "body": { "type": "multipart-form", "data": [ { "name": "File", "type": "text", "value": "" } ] } }, "docs": "Salesforce Bulk Create Batch" }, { "info": { "name": "Salesforce Bulk Retrieve Batch Result", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/async/64.0/job//batch/:_batchId/result", "headers": [ { "name": "X-SFDC-Session", "value": "example_value" }, { "name": "Accept-Encoding", "value": "example_value" }, { "name": "Content-Encoding", "value": "example_value" } ], "params": [ { "name": "_batchId", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Bulk Retrieve Batch Result" }, { "info": { "name": "Salesforce Bulk Retrieve Batch Result Data", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/async/64.0/job//batch/:_batchId/result/:batchResultId", "headers": [ { "name": "X-SFDC-Session", "value": "example_value" }, { "name": "Accept-Encoding", "value": "example_value" }, { "name": "Content-Encoding", "value": "example_value" } ], "params": [ { "name": "batchResultId", "value": "500123", "type": "path" }, { "name": "_batchId", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Bulk Retrieve Batch Result Data" }, { "info": { "name": "Salesforce Composite Batch", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/composite/batch", "body": { "type": "json", "data": "{}" } }, "docs": "Executes up to 25 subrequests in a single request. The response bodies and HTTP statuses of the subrequests in the batch are returned in a single response body. Each subrequest counts against rate limits.\nThe requests in a batch are called subrequests. All subrequests are executed in the context of the same user. Subrequests are independent, and you can’t pass information between them. Subrequests execute serially in their order in the request body. When a subrequest executes successfully, it co" }, { "info": { "name": "Salesforce Feed Elements, Batch Post", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/chatter/feed-elements/batch", "body": { "type": "json", "data": "{}" } }, "docs": "Post a batch of up to 500 feed elements.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_feed_element_batch_post.htm" }, { "info": { "name": "Salesforce Get a Batch of Records", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/records/batch/:RECORD_IDS", "params": [ { "name": "RECORD_IDS", "value": "example_value", "type": "path", "description": "Comma-separated list of record IDs" } ] }, "docs": "Get data for a batch of records." }, { "info": { "name": "Salesforce Update a Batch of Favorites", "type": "http" }, "http": { "method": "PUT", "url": "https://login.salesforce.com/data/v64.0/ui-api/favorites/batch", "body": { "type": "json", "data": "{}" } }, "docs": "Update all favorites at once. The sort order is updated to the given relative ordering. Any favorites missing from the request body are deleted." } ] }, { "info": { "name": "Data", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Upload Job Data", "type": "http" }, "http": { "method": "PUT", "url": "https://login.salesforce.com/data/v64.0/jobs/ingest//batches", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "body": { "type": "multipart-form", "data": [ { "name": "File", "type": "text", "value": "" } ] } }, "docs": "Salesforce Upload Job Data" }, { "info": { "name": "Salesforce Runexpressionset", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/actions/custom/runExpressionSet/:expressionSetAPIName", "params": [ { "name": "expressionSetAPIName", "value": "example_value", "type": "path", "description": "The API name of an expression set is unique within your Salesforce instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "# Expression Set Actions\n\nInvoke an active expression set. An expression set is a user-defined rule that accepts an input and returns the output based on the configured function.\n\nThe configured function of an expression set can be a simple decision matrix lookup, a calculation based on a mathematical formula, a condition, or another expression set.\n\nThese actions are available in API version 55.0 and later.\n\n## Supported REST HTTP Methods\n\nURI/services/data/v55.0/actions/custom/runExpressionSet" }, { "info": { "name": "Salesforce Rundecisionmatrix", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/actions/custom/runDecisionMatrix/:UniqueName", "params": [ { "name": "UniqueName", "value": "example_value", "type": "path", "description": "The value of UniqueName is the unique identifier of the record, which is sourced from the name of a decision matrix." } ], "body": { "type": "json", "data": "{}" } }, "docs": "# Decision Matrix Actions\n\nInvoke a decision matrix in a flow with the Decision Matrix Actions. A decision matrix is a user-defined table where you can look up an output based on the inputs you provide.\n\nFor example, you can look up a candidate’s eligibility to avail medical insurance in a decision matrix based on the candidate’s age and gender.\n\nThese actions are available in API version 55.0 and later.\n\n## Supported REST HTTP Methods\n\nURI/services/data/v55.0/actions/custom/runDecisionMatrix/{U" }, { "info": { "name": "Salesforce Sobject Approvallayouts", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/describe/approvalLayouts/:APPROVAL_PROCESS_NAME", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "APPROVAL_PROCESS_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Returns a list of approval layouts for a specified object. Specify a particular approval process name to limit the return value to one specific approval layout. This resource is available in REST API version 30.0 and later.\n\napprovalProcessName parameter is optional" }, { "info": { "name": "Salesforce Sobject Compactlayouts", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/describe/describe/compactLayouts", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Returns a list of compact layouts for a specific object. This resource is available in REST API version 29.0 and later." }, { "info": { "name": "Salesforce Sobject Platformaction", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/PlatformAction", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "PlatformAction is a virtual read-only object. It enables you to query for actions displayed in the UI, given a user, a context, device format, and a record ID. Examples include standard and custom buttons, quick actions, and productivity actions.\nReturns the description of the PlatformAction." }, { "info": { "name": "Salesforce Data Category Groups", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/support/dataCategoryGroups", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "sObjectName", "value": "example_value", "type": "query" } ] }, "docs": "Returns the list of list views for the specified sObject, including the ID and other basic information about each list view. You can also get basic information for a specific list view by ID." }, { "info": { "name": "Salesforce Data Category Detail", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/support/dataCategoryGroups/:GROUP/dataCategories/:CATEGORY", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "GROUP", "value": "example_value", "type": "path" }, { "name": "CATEGORY", "value": "example_value", "type": "path" } ] }, "docs": "Get data category details and the child categories by a given category." }, { "info": { "name": "Salesforce Articles Details", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/support/knowledgeArticles/:ARTICLE_ID", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "ARTICLE_ID", "value": "500123", "type": "path" } ] }, "docs": "Get all online article fields, accessible to the user." }, { "info": { "name": "Salesforce Limits", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/limits" }, "docs": "Lists information about limits in your org. For each limit, this resource returns the maximum allocation and the remaining allocation based on usage. This resource is available in REST API version 29.0 and later for API users with the View Setup and Configuration permission" }, { "info": { "name": "Salesforce Appmenu", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/appMenu", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Returns a list of items in either the Salesforce app drop-down menu or the Salesforce for Android, iOS, and mobile web navigation menu." }, { "info": { "name": "Salesforce Queryall", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/queryAll", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "q", "value": "example_value", "type": "query" } ] }, "docs": "Executes the specified SOQL query. Unlike the Query resource, QueryAll will return records that have been deleted because of a merge or delete. QueryAll will also return information about archived Task and Event records. QueryAll is available in API version 29.0 and later.\n\nIf the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next" }, { "info": { "name": "Salesforce Createassetfromorder", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/actions/standard/createOrUpdateAssetFromOrder", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Createassetfromorder" }, { "info": { "name": "Salesforce Tooling Executeanonymous", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/executeAnonymous", "params": [ { "name": "anonymousBody", "value": "example_value", "type": "query" } ] }, "docs": "Executes Apex code anonymously. Available from API version 29.0 or later." }, { "info": { "name": "Salesforce Get Record Data and Object Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/record-ui/:RECORD_IDS", "params": [ { "name": "RECORD_IDS", "value": "example_value", "type": "path", "description": "Comma-separated list of record IDs" } ] }, "docs": "Get layout information, metadata, and data to build UI for a single record or for a collection of records.\nThe response contains layout information for whichever layout types are specified in the layoutTypes parameter.\n\nIt contains data for the records specified in the recordIds parameter.\n\nThe response contains object metadata for the object types of the records specified in the recordIds parameter, and for any nested objects. For example, a request to /ui-api/record-ui/001RM000003RsOHYA0, whic" } ] }, { "info": { "name": "Failed", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get Job Failed Record Results", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/jobs/ingest//failedResults" }, "docs": "Salesforce Get Job Failed Record Results" } ] }, { "info": { "name": "Composite", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Composite", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/composite", "headers": [ { "name": "Authorization", "value": "example_value" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Executes a series of REST API requests in a single call. You can use the output of one request as the input to a subsequent request. The response bodies and HTTP statuses of the requests are returned in a single response body. The entire request counts as a single call toward your API limits.\nThe requests in a composite call are called subrequests. All subrequests are executed in the context of the same user. In a subrequest’s body, you specify a reference ID that maps to the subrequest’s respon" }, { "info": { "name": "Salesforce Composite Graph", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/composite/graph", "body": { "type": "json", "data": "{}" } }, "docs": "Composite graphs provide an enhanced way to perform composite requests, which execute a series of REST API requests in a single call.\nRegular composite requests allow you to execute a series of REST API requests in a single call. And you can use the output of one request as the input to a subsequent request.\n\nComposite graphs extend this by allowing you to assemble a more complicated and complete series of related objects and records.\n\nComposite graphs also enable you to ensure that the steps in" } ] }, { "info": { "name": "Trees", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Sobject Tree", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/composite/tree/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates one or more sObject trees with root records of the specified type. An sObject tree is a collection of nested, parent-child records with a single root record.\nIn the request data, you supply the record hierarchies, required and optional field values, each record’s type, and a reference ID for each record. Upon success, the response contains the IDs of the created records. If an error occurs while creating a record, the entire request fails. In this case, the response contains only the ref" } ] }, { "info": { "name": "Files", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Users Files, General", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/files/users/me", "body": { "type": "multipart-form", "data": [ { "name": "fileData", "type": "text", "value": "" } ] } }, "docs": "Upload a file, including references to external files, to the Files home or get information about files a user owns. These files don’t include files shared with a user, files a user follows, or general organization files.\nWhen you upload a file to the Files home, it is private and available only to the file owner.\n\nTo upload a file, send it in a multipart/form-data request. You can include the description and title of the file in the multipart/form-data request as a JSON or XML request body. You" }, { "info": { "name": "Salesforce File Information", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/connect/files/:FILE_ID", "params": [ { "name": "FILE_ID", "value": "500123", "type": "path" } ] }, "docs": "Get information about a specified file, including references to external files. Upload a new version of an existing file, including references to external files. Rename a file, move a file to a different folder, and delete a file.\nTo upload a new version of an existing file, make a POST request. Upload the new version as a binary part in a multipart/form-data request. See Uploading Binary Files. To upload a new file to the Files home, use /connect/files/users/me.Get information about a specified" }, { "info": { "name": "Salesforce File Shares", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/connect/files/:FILE_ID/file-shares", "params": [ { "name": "FILE_ID", "value": "500123", "type": "path" } ] }, "docs": "Returns information about the objects with which the specified file has been shared. Objects can be users, groups, or records.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_shares.htm" }, { "info": { "name": "Salesforce Files Shares Link", "type": "http" }, "http": { "method": "PUT", "url": "https://login.salesforce.com/data/v64.0/connect/files/:FILE_ID/file-shares/link", "params": [ { "name": "FILE_ID", "value": "500123", "type": "path" } ] }, "docs": "A description of a file shared as a link. Create, access, and delete a file’s share link.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_shares_link.htm" } ] }, { "info": { "name": "Content", "type": "folder" }, "items": [ { "info": { "name": "Salesforce File Content", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/connect/files/:FILE_ID/content", "params": [ { "name": "FILE_ID", "value": "500123", "type": "path" } ] }, "docs": "Returns the binary content of the file, including references to external files. The content is streamed as the body of the response.\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_content.htm" } ] }, { "info": { "name": "Credential", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get Credential", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/named-credentials/credential", "params": [ { "name": "externalCredential", "value": "example_value", "type": "query", "description": "Fully qualified developer name of the external credential." }, { "name": "principalName", "value": "example_value", "type": "query", "description": "Name of the external credential named principal." }, { "name": "principalType", "value": "example_value", "type": "query", "description": "Type of credential principal. Values are:\n* AwsStsPrincipal\n* NamedPrincipal\n* PerUserPrincipal" } ] }, "docs": "Get a credential." }, { "info": { "name": "Salesforce Update Credential", "type": "http" }, "http": { "method": "PUT", "url": "https://login.salesforce.com/data/v64.0/named-credentials/credential", "body": { "type": "json", "data": "{}" } }, "docs": "Update a credential." }, { "info": { "name": "Salesforce Delete Credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/named-credentials/credential", "body": { "type": "json", "data": "{}" } }, "docs": "Delete a credential." }, { "info": { "name": "Salesforce Update External Credential", "type": "http" }, "http": { "method": "PUT", "url": "https://login.salesforce.com/data/v64.0/named-credentials/external-credentials/:DEVELOPER_NAME", "params": [ { "name": "DEVELOPER_NAME", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an external credential." }, { "info": { "name": "Salesforce Delete External Credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/named-credentials/external-credentials/:DEVELOPER_NAME", "params": [ { "name": "DEVELOPER_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Delete an external credential." }, { "info": { "name": "Salesforce Get Named Credential by Developer Name", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/named-credentials/named-credential-setup/:DEVELOPER_NAME", "params": [ { "name": "DEVELOPER_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Get a named credential." }, { "info": { "name": "Salesforce Update Named Credential", "type": "http" }, "http": { "method": "PUT", "url": "https://login.salesforce.com/data/v64.0/named-credentials/named-credential-setup/:DEVELOPER_NAME", "params": [ { "name": "DEVELOPER_NAME", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a named credential." }, { "info": { "name": "Salesforce Get Named Credential", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/NamedCredential/:NAMED_CREDENTIAL_ID", "params": [ { "name": "NAMED_CREDENTIAL_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Named Credential" }, { "info": { "name": "Salesforce Update Named Credential", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/NamedCredential/:NAMED_CREDENTIAL_ID", "params": [ { "name": "NAMED_CREDENTIAL_ID", "value": "500123", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Update Named Credential" }, { "info": { "name": "Salesforce Delete Named Credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/NamedCredential/:NAMED_CREDENTIAL_ID", "params": [ { "name": "NAMED_CREDENTIAL_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Delete Named Credential" } ] }, { "info": { "name": "Credentials", "type": "folder" }, "items": [ { "info": { "name": "Salesforce List External Credentials", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/named-credentials/external-credentials" }, "docs": "Get external credentials that the user can authenticate to." }, { "info": { "name": "Salesforce List Named Credentials", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/named-credentials/named-credential-setup" }, "docs": "Get a list of named credentials in the org." }, { "info": { "name": "Salesforce Get External Credentials by Developer Name", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/named-credentials/external-credentials/:DEVELOPER_NAME", "params": [ { "name": "DEVELOPER_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Get an external credential, including the named credentials and principals associated with it and the type and status of each principal." }, { "info": { "name": "Salesforce List Named Credentials", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/query", "params": [ { "name": "q", "value": "example_value", "type": "query" } ] }, "docs": "Salesforce List Named Credentials" } ] }, { "info": { "name": "Elements", "type": "folder" }, "items": [ { "info": { "name": "Salesforce News Feed Elements", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/chatter/feeds/news/me/feed-elements" }, "docs": "All feed elements from all groups the context user either owns or is a member of, as well as all files, records, and users the context user follows. Use this resource to get information about feed elements and to post feed elements.\n\nFor information about posting a feed element, see Feed Elements, Post and Search.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resource_feeds_news.htm#cc_news_feed_elements" }, { "info": { "name": "Salesforce User Profile Feed Elements", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/chatter/feeds/user-profile/:USER_ID/feed-elements", "params": [ { "name": "USER_ID", "value": "500123", "type": "path" } ] }, "docs": "Returns feed elements created when a user changes records that can be tracked in a feed, feed elements whose parent is the user, and feed elements that mention the user. This feed is different than the news feed, which returns more feed items, including group updates. You can post feed items to the user-profile feed. You can get another user’s user profile feed.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resource_feeds_user_profile.htm" }, { "info": { "name": "Salesforce Record Feed Elements", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/chatter/feeds/record/:RECORD_GROUP_ID/feed-elements", "params": [ { "name": "RECORD_GROUP_ID", "value": "500123", "type": "path" } ] }, "docs": "Returns the feed elements for all the records the context user is following, or all the feed elements of the specified recordId. Use this resource to search a feed or to get the feed elements for a specific feed, including another user’s feed. To use this resource to get the feed elements for a group, specify the group ID as the recordId.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resource_feeds_record.htm" }, { "info": { "name": "Salesforce Feed Elements, Post and Search", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/chatter/feed-elements", "params": [ { "name": "feedElementType", "value": "example_value", "type": "query", "description": "Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values:\nBundle—A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values.\nFeedItem—A feed item has a single parent and is scoped to one community or across all communities. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values.\nRecommendation—A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user." }, { "name": "subjectId", "value": "500123", "type": "query" }, { "name": "text", "value": "example_value", "type": "query" } ] }, "docs": "Feed item and comment bodies have a 10,000 character limit. Because this limit can change, we recommend that clients make a describeSObjects() call on the FeedItem or FeedComment object. To determine the maximum number of allowed characters, look at the length of the Body or CommentBody field.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_feed_element.htm" } ] }, { "info": { "name": "Capability", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Feed Elements Capability, Comments Items", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/chatter/feed-elements/:FEED_ELEMENT_ID/capabilities/comments/items", "params": [ { "name": "text", "value": "example_value", "type": "query" }, { "name": "FEED_ELEMENT_ID", "value": "500123", "type": "path" } ] }, "docs": "Access comments for a feed element, or add a comment to a feed element.\nTo upload a binary file to attach to a comment, you must send it in a multipart/form-data request. To send the text of the comment, you can choose to include a JSON or XML rich input body part in the multipart/form-data request. Alternately, you can choose to pass the information in request parameter parts. For information about how to create the multipart/form-data message, see Uploading Binary Files.\n\nhttps://developer.sal" } ] }, { "info": { "name": "Comments", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Comment", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/chatter/comments/:COMMENT_ID", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "COMMENT_ID", "value": "500123", "type": "path" } ] }, "docs": "Get information about, edit, or delete a comment.\nTo post a comment, use Feed Elements Capability, Comments Items.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_comments_specific.htm#connect_resources_comments_specific" }, { "info": { "name": "Salesforce Comment - Edit", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/chatter/comments/:COMMENT_ID", "params": [ { "name": "COMMENT_ID", "value": "500123", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get information about, edit, or delete a comment.\nTo post a comment, use Feed Elements Capability, Comments Items.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_comments_specific.htm#connect_resources_comments_specific" }, { "info": { "name": "Salesforce Comment - Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/chatter/comments/:COMMENT_ID", "params": [ { "name": "COMMENT_ID", "value": "500123", "type": "path" } ] }, "docs": "Get information about, edit, or delete a comment.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_comments_specific.htm#connect_resources_comments_specific" } ] }, { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "Salesforce List of Groups", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/chatter/groups" }, "docs": "A list of all the groups in the organization. Get information about groups or create a group.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_ListOfGroups.htm" }, { "info": { "name": "Salesforce List of Groups - Post", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/chatter/groups", "params": [ { "name": "name", "value": "Example Title", "type": "query" }, { "name": "visibility", "value": "example_value", "type": "query", "description": "PrivateAccess—Only members of the group can see posts to this group.\nPublicAccess—All users within the community can see posts to this group.\nUnlisted—Reserved for future use." }, { "name": "description", "value": "A sample description.", "type": "query" }, { "name": "information", "value": "example_value", "type": "query", "description": "If the group is private, the “Information” section is visible only to members." }, { "name": "isArchived", "value": "true", "type": "query" }, { "name": "isAutoArchiveDisabled", "value": "true", "type": "query", "description": "true if automatic archiving is turned off for the group, false otherwise. Defaults to false. If true, if there are no posts or comments for 90 days the group is archived." }, { "name": "isBroadcast", "value": "true", "type": "query", "description": "true if only group owners and managers can create posts in the group, false otherwise." }, { "name": "canHaveChatterGuests", "value": "true", "type": "query" } ] }, "docs": "A list of all the groups in the organization. Get information about groups or create a group.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_ListOfGroups.htm" }, { "info": { "name": "Salesforce Group Members—private", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/chatter/groups/:GROUP_ID/members/requests", "params": [ { "name": "GROUP_ID", "value": "500123", "type": "path" } ] }, "docs": "Request membership in a private group or get the status of requests to a join a private group.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_GroupMembersRequests.htm" }, { "info": { "name": "Salesforce Group Members—private - Post", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/chatter/groups/:GROUP_ID/members/requests", "params": [ { "name": "GROUP_ID", "value": "500123", "type": "path" } ] }, "docs": "Request membership in a private group or get the status of requests to a join a private group.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_GroupMembersRequests.htm" }, { "info": { "name": "Salesforce Group Invites", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/chatter/groups/group/:GROUP_ID/invite", "params": [ { "name": "GROUP_ID", "value": "500123", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invite internal and external users to join a group.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_invites.htm#connect_resources_groups_invites" }, { "info": { "name": "Salesforce Group Members", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/chatter/groups/:GROUP_ID/members", "params": [ { "name": "userId", "value": "500123", "type": "query" }, { "name": "GROUP_ID", "value": "500123", "type": "path" } ] }, "docs": "Members of a specified group. Get the members and add a member to a group. To add a member, the context user must be the group owner or moderator.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_GroupMembers.htm" }, { "info": { "name": "Salesforce Group Membership Requests—private", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/chatter/group-membership-requests/:CHATTER_GROUP_REQUEST_ID", "params": [ { "name": "status", "value": "example_value", "type": "query" }, { "name": "responseMessage", "value": "example_value", "type": "query" }, { "name": "CHATTER_GROUP_REQUEST_ID", "value": "500123", "type": "path" } ] }, "docs": "Update the status of a request by a user to join a private group or get information about a request to join a private group.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_group_membership_requests.htm?search_text=group-membership-requests" } ] }, { "info": { "name": "Photo", "type": "folder" }, "items": [ { "info": { "name": "Salesforce User Photo", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/user-profiles/me/photo", "body": { "type": "multipart-form", "data": [ { "name": "json", "type": "text", "value": "" }, { "name": "fileUpload", "type": "text", "value": "" } ] } }, "docs": "Get, post, and crop a user photo.\nTo use an image from the Files page as a user photo, pass the file ID in the fileId property of the request body or in the fileId request parameter. Images uploaded on the User page don’t have a file ID and can’t be used as the fileId.\n\nTo upload a binary file as the user photo, you must send it in a multipart/form-data message. For information about how to create the multipart/form-data message, see Uploading Binary Files.\n\nTo display user profile photos in a f" } ] }, { "info": { "name": "General", "type": "folder" }, "items": [ { "info": { "name": "Salesforce User Messages, General", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/chatter/users/me/messages", "params": [ { "name": "text", "value": "example_value", "type": "query" }, { "name": "recipients", "value": "example_value", "type": "query", "description": "Comma-separated list of User IDs" } ] }, "docs": "Returns all the messages for all the private conversations for the context user. Also used to search across all messages and post a message.\nTo return all private conversations for the context user, see User Conversations, General.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_users_messages_general.htm" } ] }, { "info": { "name": "Following", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Following", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/chatter/users/:USER_ID/following", "params": [ { "name": "USER_ID", "value": "500123", "type": "path" } ] }, "docs": "Returns a list of people, groups, records, topics, and files that the specified user is following. Also used to follow records.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_users_FollowingUsers.htm?search_text=following" }, { "info": { "name": "Salesforce Following - Post", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/chatter/users/:USER_ID/following", "params": [ { "name": "subjectId", "value": "500123", "type": "query" }, { "name": "USER_ID", "value": "500123", "type": "path" } ] }, "docs": "Returns a list of people, groups, records, topics, and files that the specified user is following. Also used to follow records.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_users_FollowingUsers.htm?search_text=following" } ] }, { "info": { "name": "Dependencies", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Retrieve Expression Set Version Dependencies", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/expression-set/version/:expressionSetVersionId/dependencies", "params": [ { "name": "expressionSetVersionId", "value": "500123", "type": "path", "description": "Expression Set Version Id: For Example 9QLHo000000LBjEOAW" } ] }, "docs": "[https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_resources_expression_set_dependencies.htm](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_resources_expression_set_dependencies.htm)\n\n# Expression Set Version Dependencies (GET)\n\nRetrieve expression set version dependencies.Resource\n\n```\n/connect/business-rules/expression-set/version/${expressionSetVersionId}/dependencies\n\n ```\n\nResou" } ] }, { "info": { "name": "Creation", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Expression Set Creation", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/expression-set", "body": { "type": "json", "data": "{}" } }, "docs": "[https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_resources_bre_create_expression_set.htm](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_resources_bre_create_expression_set.htm)\n\n# Expression Set Creation (POST)\n\nCreates an expression set in Business Rules Engine. An expression set performs a series of calculations by using lookup tables and user-defined variables and co" }, { "info": { "name": "Salesforce Promotions Creation", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/global-promotions-management/promotions", "body": { "type": "json", "data": "{}" } }, "docs": "[Promotions Creation](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_unified_promotions.htm)\n\nNOTE:\n\nIn the Pre-request. Script Tab, make changes in the variables value accordingly with the real Process Name to invoke." } ] }, { "info": { "name": "Expression", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Expression Set Retrieve", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/expression-set/:expressionSetId", "params": [ { "name": "expressionSetId", "value": "500123", "type": "path", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] }, "docs": "# Expression Set Retrieve and Delete (DELETE, GET)\n\nEndpoints to read, and delete expression set.Resource\n\n```\n/connect/business-rules/expression-set/${expressionSetId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect\n /business-rules/expressionSet/$11Oxx0000006PcLEAU\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nDELETE, GET\n\nRequest body for GET\n\nRoot XML tag\n\nJSON example\n\n```\n{\n \"name\": \"CTX Mapping ES\",\n \"apiName\"" }, { "info": { "name": "Salesforce Expression Set Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/expression-set/:expressionSetId", "params": [ { "name": "expressionSetId", "value": "500123", "type": "path", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ], "body": { "type": "json", "data": "{}" } }, "docs": "# Expression Set Update (PATCH)\n\nEndpoints to read, and update expression set.Resource\n\n```\n/connect/business-rules/expression-set/${expressionSetId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect\n /business-rules/expressionSet/$11Oxx0000006PcLEAU\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nDELETE, GET, PATCH\n\nResponse body for GET\n\n[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries" }, { "info": { "name": "Salesforce Expression Set Invocation", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/expressionset/:expressionSetAPIName", "params": [ { "name": "expressionSetAPIName", "value": "example_value", "type": "path", "description": "The API name of an expression set is unique within your Salesforce instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "[https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_resources_bre_expression_set.htm](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_resources_bre_expression_set.htm)\n\n**WATCH OUT**: path **expressionSet** has no dash [gjeffcock@salesforce.com](https://gjeffcock@salesforce.com)\n\n# Expression Set Invocation (POST)\n\nInvokes expression sets in Business Rule Engine.Resource\n\n``" } ] }, { "info": { "name": "Table", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Lookup Table", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/decision-matrices/:matrixUniqueName", "params": [ { "name": "matrixUniqueName", "value": "example_value", "type": "path", "description": "The value of Unique Name is the unique identifier of the record, which is sourced from the name of a decision matrix." } ], "body": { "type": "json", "data": "{}" } }, "docs": "# Decision Matrix (Lookup Table)\n\nPerforms a lookup on decision matrix rows based on the input values provided, and returns the row’s output.Resource\n\n```\n/connect/business-rules/decision-matrices/${matrixName}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/vXX.X/connect\n/business-rules/decision-matrices/InsurancePremium\n\n ```\n\nAvailable version\n\n55.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nRequest body for POST\n\nJSON example\n\n```\n{\n \"inputs\": [\n {\n \"i" }, { "info": { "name": "Salesforce Update Table", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/decision-table/definitions/:decisionTableId", "params": [ { "name": "decisionTableId", "value": "500123", "type": "path", "description": "Decision Table Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "# Decision Table Definitions ( DELETE)\n\nDelete a decision table definition associated with a decision table.\n\nResource\n\n```\n/connect/business-rules/decision-table/definitions/${decisionTableId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-table/definitions/0lDxx00000002Ur\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nDELETE\n\nResponse body for DELETE\n\n[Decision Table Output](https://developer.salesforce." }, { "info": { "name": "Salesforce Lookup Table", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/decision-table/:decisionTableId", "params": [ { "name": "decisionTableId", "value": "500123", "type": "path", "description": "Decision Table Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "# Decision Table (Lookup Table)\n\nPerforms a lookup on a decision table.Resource\n\n```\n/connect/business-rules/decision-table/${decisionTableId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v55.0/connect\n/decision-table/0lDB0000000TNQzMAO\n\n ```\n\nAvailable version\n\n55.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nRequest body for POST\n\nJSON example\n\n```\n{\n \"conditions\" : {\n \"conditionsList\" : [\n {\n \"fieldName\": \"state__c\",\n \"valu" } ] }, { "info": { "name": "Decision", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Decision Model Notation Export", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/decision-models/export", "body": { "type": "json", "data": "{}" } }, "docs": "# Decision Model Notation Export (POST)\n\nExport decision matrix data to a file in the [DMN (Decision Model Notation)](https://www.omg.org/dmn/#:~:text=DMN%20is%20a%20modeling%20language,monitor%20their%20application;%20business%20analysts.) format, an easily readable format for business rules designed by Object Management Group.Resource\n\n```\n/connect/business-rules/decision-models/export\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/d" } ] }, { "info": { "name": "Invoke", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Invoke", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/decision-table/lookup/:decisionTableId", "params": [ { "name": "decisionTableId", "value": "500123", "type": "path", "description": "Decision Table Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "# Invoke Decision Tables\n\nInvoke a decision table by passing multiple input conditions within the same request.Resource\n\n```\n/connect/business-rules/decision-table/lookup/${decisionTableId}\n\n ```\n\nResource example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect\n/business-rules/decision-table/lookup/${0lDD2000000004NMAQ}\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nRequest body for POST\n\nJSON example\n\n```\n{\n \"datasetLinkName\" : \"transactionMappi" } ] }, { "info": { "name": "Retrieves", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Retrieve Lookup Tables", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/connect/business-rules/lookup-tables", "params": [ { "name": "searchKey", "value": "example_value", "type": "query" }, { "name": "usageType", "value": "example_value", "type": "query" }, { "name": "lookupTypes", "value": "example_value", "type": "query", "description": "Optional: Type of lookup table. Valid values are: DecisionMatrix, DecisionTable" } ] }, "docs": "# Lookup Tables (GET)\n\nRetrieve lookup tables.Resource\n\n```\n/connect/business-rules/lookup-tables\n\n ```\n\nResource example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/lookup-tables?searchKey=D&usageType=Bre&lookupTypes=DecisionTable,DecisionMatrix\n\n ```\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/lookup-tables?searchKey=D&usageType=Bre\n\n ```\n\nAvailable version59.0Requires ChatterNoHTTP methodsGETRequest parameters for" }, { "info": { "name": "Salesforce Retrieve Openapi Schema", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/async/specifications/oas3/:schemaId", "params": [ { "name": "schemaId", "value": "500123", "type": "path", "description": "Identifier that was returned in the original request to generate the Schema." } ] }, "docs": "Generate an OpenAPI 3.0 document for the sObjects REST API. This is a [Beta feature](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/openapi_beta.htm) that requires an activation step before it can be used." } ] }, { "info": { "name": "Add", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Add an Item to a Cart", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/commerce/webstores//carts/:webCartId/cart-items", "params": [ { "name": "effectiveAccountId", "value": "500123", "type": "query" }, { "name": "webCartId", "value": "500123", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Add an Item to a Cart" }, { "info": { "name": "Salesforce Add Enriched Fields to Channel Member", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID", "params": [ { "name": "PLATFORM_EVENT_CHANNEL_MEMBER_ID", "value": "500123", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Add Enriched Fields to Channel Member" } ] }, { "info": { "name": "Gift", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Update Gift Transaction Payments", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/fundraising/transactions/payment-updates", "body": { "type": "json", "data": "{}" } }, "docs": "Update the gateway and processor metadata for gift transactions.\n\n## Required Attributes:\n\n- giftTransactionId\n \n- transactionStatus" } ] }, { "info": { "name": "Update", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Update Commitments", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/connect/fundraising/commitments/:commitmentId", "params": [ { "name": "commitmentId", "value": "500123", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the schedule or payment instrument metadata on an existing active gift commitment.\n\n## Required Attributes:\n\n- {commitmentId}\n \n- amount\n \n- transactionPeriod (Monthly, Weekly, Yearly, etc.)\n \n- startDate\n \n- paymentInstrument.type\n \n\nAll other attributes are optional can be left as an empty string or just removed from the request body entirely. The only exceptions to this are:\n\n- CustomFields collections - These cannot be left in the request body as an empty collection or " } ] }, { "info": { "name": "Commitment", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Update Commitment Payments", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/fundraising/commitments/payment-updates", "body": { "type": "json", "data": "{}" } }, "docs": "Update the future payment instrument metadata for active gift commitments.\n\n## Required Attributes:\n\n- giftCommitmentId\n \n- paymentInstrument.type" } ] }, { "info": { "name": "Based", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Generate Response Based on Prompt Template", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/einstein/prompt-templates/:PROMPT_TEMPLATE_API_NAME/generations", "params": [ { "name": "PROMPT_TEMPLATE_API_NAME", "value": "example_value", "type": "path", "description": "API name of the prompt template to invoke" } ] }, "docs": "Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm))." } ] }, { "info": { "name": "Conversation", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get Conversation Entries", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/connect/conversation/:conversationIdentifier/entries", "params": [ { "name": "conversationIdentifier", "value": "example_value", "type": "path", "description": "Conversation identifier UUID" } ] }, "docs": "Gets in-app messaging conversation entries.\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_conversation_entries.htm" } ] }, { "info": { "name": "Predict", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Predict", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/smartdatadiscovery/predict", "body": { "type": "json", "data": "{}" } }, "docs": "Get available prediction definitions." } ] }, { "info": { "name": "Definitions", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Prediction Definitions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/smartdatadiscovery/predictionDefinitions" }, "docs": "Get available prediction definitions." } ] }, { "info": { "name": "Definition", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Prediction Definition Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID", "params": [ { "name": "PREDICTION_DEFINITION_ID", "value": "500123", "type": "path" } ] }, "docs": "Get available prediction definitions." } ] }, { "info": { "name": "Models", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Prediction Models", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID/models", "params": [ { "name": "PREDICTION_DEFINITION_ID", "value": "500123", "type": "path" } ] }, "docs": "Get available prediction definitions." } ] }, { "info": { "name": "Channel", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Create Channel", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/PlatformEventChannel", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Create Channel" }, { "info": { "name": "Salesforce Get Event Channel", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID", "params": [ { "name": "PLATFORM_EVENT_CHANNEL_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Event Channel" }, { "info": { "name": "Salesforce Update Channel", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID", "params": [ { "name": "PLATFORM_EVENT_CHANNEL_ID", "value": "500123", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Update Channel" }, { "info": { "name": "Salesforce Delete Event Channel", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID", "params": [ { "name": "PLATFORM_EVENT_CHANNEL_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Delete Event Channel" }, { "info": { "name": "Salesforce Get Channel Member", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID", "params": [ { "name": "PLATFORM_EVENT_CHANNEL_MEMBER_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Channel Member" }, { "info": { "name": "Salesforce Delete Channel Member", "type": "http" }, "http": { "method": "DELETE", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID", "params": [ { "name": "PLATFORM_EVENT_CHANNEL_MEMBER_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Delete Channel Member" }, { "info": { "name": "Salesforce Create Channel Member", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/PlatformEventChannelMember", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Create Channel Member" }, { "info": { "name": "Salesforce Describe Event Channel", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/PlatformEventChannel/describe" }, "docs": "Salesforce Describe Event Channel" } ] }, { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Publish Single Event", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/sobjects/:EventApiName", "params": [ { "name": "EventApiName", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Publish Single Event" }, { "info": { "name": "Salesforce Get Event Relay", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/EventRelayConfig/:EVENT_RELAY_CONFIG_ID", "params": [ { "name": "EVENT_RELAY_CONFIG_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Event Relay" }, { "info": { "name": "Salesforce List Event Relay Feedback Items", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/query", "params": [ { "name": "q", "value": "example_value", "type": "query" } ] }, "docs": "Salesforce List Event Relay Feedback Items" }, { "info": { "name": "Salesforce Get Event Relay Feedback", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/EventRelayFeedback/:EVENT_RELAY_FEEDBACK_ID", "params": [ { "name": "EVENT_RELAY_FEEDBACK_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Event Relay Feedback" }, { "info": { "name": "Salesforce Platform Event Schema by Schema Id", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/event/eventSchema/:SCHEMA_ID", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SCHEMA_ID", "value": "500123", "type": "path" } ] }, "docs": "Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later." }, { "info": { "name": "Salesforce Platform Event Schema by Event Name", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:EVENT_NAME/eventSchema", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "EVENT_NAME", "value": "example_value", "type": "path", "description": "API Name of the event" } ] }, "docs": "Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later." }, { "info": { "name": "Salesforce Get Managed Event Subscription by Id", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/ManagedEventSubscription/:managedEventSubscriptionId", "params": [ { "name": "managedEventSubscriptionId", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Managed Event Subscription by Id" }, { "info": { "name": "Salesforce Update Managed Event Subscription", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/ManagedEventSubscription/:managedEventSubscriptionId", "params": [ { "name": "managedEventSubscriptionId", "value": "500123", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Update Managed Event Subscription" }, { "info": { "name": "Salesforce Get Event Log File", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/EventLogFile/:id/LogFile", "params": [ { "name": "id", "value": "abc123", "type": "path", "description": "Log event Id" } ] }, "docs": "Salesforce Get Event Log File" } ] }, { "info": { "name": "Call", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Publish Multiple Events With Soap Call", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/Soap/u/64.0", "headers": [ { "name": "Content-Type", "value": "example_value" }, { "name": "charset", "value": "example_value" }, { "name": "SOAPAction", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ] }, "docs": "Salesforce Publish Multiple Events With Soap Call" } ] }, { "info": { "name": "Describe", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Describe Event Relay", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/EventRelayConfig/describe" }, "docs": "Salesforce Describe Event Relay" }, { "info": { "name": "Salesforce Describe Event Felay Feedback", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/EventRelayFeedback/describe" }, "docs": "Salesforce Describe Event Felay Feedback" }, { "info": { "name": "Salesforce Describe Managed Event Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/ManagedEventSubscription/describe" }, "docs": "Salesforce Describe Managed Event Subscription" }, { "info": { "name": "Salesforce Describe Global", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Lists the available objects and their metadata for your organization’s data. In addition, it provides the organization encoding, as well as the maximum batch size permitted in queries.\n\nYou can use the If-Modified-Since header with this resource, with the date format EEE, dd MMM yyyy HH:mm:ss z. When using this header, if no available object’s metadata has changed since the provided date, a 304 Not Modified status code is returned with no response body." }, { "info": { "name": "Salesforce Sobject Describe", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/describe", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "Object API name" } ] }, "docs": "Describes the individual metadata for the specified object. Can also be used to create a new record for a given object. For example, this can be used to retrieve the metadata for the Account object using the GET method, or create a new Account object using the POST method." }, { "info": { "name": "Salesforce Describe Global Layouts", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/Global/describe/layouts", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Returns a list of layouts and descriptions. The list of fields and the layout name are returned." }, { "info": { "name": "Salesforce Describe Sobject Layouts", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/describe/layouts", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Returns a list of layouts and descriptions. The list of fields and the layout name are returned." }, { "info": { "name": "Salesforce Describe Sobject Layouts Per Record Type", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/describe/layouts/:RECORD_TYPE_ID", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "RECORD_TYPE_ID", "value": "500123", "type": "path" } ] }, "docs": "Returns a list of layouts and descriptions. The list of fields and the layout name are returned." }, { "info": { "name": "Salesforce List View Describe", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/listviews/:QUERY_LOCATOR/describe", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "QUERY_LOCATOR", "value": "example_value", "type": "path" } ] }, "docs": "Returns detailed information about a list view, including the ID, the columns, and the SOQL query." }, { "info": { "name": "Salesforce Get Tooling Describe", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects" }, "docs": "Lists the available Tooling API objects and their metadata." }, { "info": { "name": "Salesforce Get Tooling Describe Sobject", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/:SOBJECT_API_NAME/describe", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Salesforce Get Tooling Describe Sobject" } ] }, { "info": { "name": "Change", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Change Event Relay State", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/EventRelayConfig/:EVENT_RELAY_CONFIG_ID", "headers": [ { "name": "SOAPAction", "value": "example_value" }, { "name": "Authorization", "value": "example_value" } ], "params": [ { "name": "EVENT_RELAY_CONFIG_ID", "value": "500123", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Change Event Relay State" } ] }, { "info": { "name": "Quote", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Read Quote Api", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/apexrest/SBQQ/ServiceRouter", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "reader", "value": "example_value", "type": "query" }, { "name": "uid", "value": "500123", "type": "query" } ] }, "docs": "The Read Quote API reads a quote from a CPQ quote ID.\nAvailable in: Salesforce CPQ Summer ’16 and later\n\nhttps://developer.salesforce.com/docs/atlas.en-us.cpq_dev_api.meta/cpq_dev_api/cpq_api_read_quote.htm" }, { "info": { "name": "Salesforce Save Quote Api", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/apexrest/SBQQ/ServiceRouter", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "The Save Quote API saves a CPQ quote.\nAvailable in: Salesforce CPQ Summer ’16 and later\n\nhttps://developer.salesforce.com/docs/atlas.en-us.cpq_dev_api.meta/cpq_dev_api/cpq_quote_api_save_final.htm" } ] }, { "info": { "name": "Configuration", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Configuration Loader Api", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/apexrest/SBQQ/ServiceRouter", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "loader", "value": "example_value", "type": "query" }, { "name": "uid", "value": "500123", "type": "query" } ] }, "docs": "The Configuration Loader API returns all the data for the product, including its product options and configuration model. When configuring a nested bundle, set the parentProductproperty to the parent product to inherit configuration attributes on the nested bundle.\nAvailable in: Salesforce CPQ Spring ’17 and later\n\nhttps://developer.salesforce.com/docs/atlas.en-us.cpq_dev_api.meta/cpq_dev_api/cpq_api_config_loader.htm" }, { "info": { "name": "Salesforce Embedded Service Configuration Describe", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/support/embeddedservice/configuration/:EMBEDDED_SERVICE_CONFIG_DEVELOPERNAME", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "EMBEDDED_SERVICE_CONFIG_DEVELOPERNAME", "value": "example_value", "type": "path" } ] }, "docs": "Retrieves the values for your Embedded Service deployment configuration, including the branding colors, font, and site URL.\n\nYou must be logged in to the account that owns the EmbeddedServiceConfigDeveloperName you are querying." } ] }, { "info": { "name": "Corporate", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Corporate Member Enrollments", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/loyalty-programs/:loyaltyProgramName/corporate-member-enrollments", "params": [ { "name": "loyaltyProgramName", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_corporate_member.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_corporate_member.htm)" } ] }, { "info": { "name": "Individual", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Individual Member Enrollments", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/loyalty-programs/:loyaltyProgramName/individual-member-enrollments", "params": [ { "name": "loyaltyProgramName", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_individual_member.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_individual_member.htm)" } ] }, { "info": { "name": "Benefits", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Member Benefits", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/connect/loyalty/member/:memberId/memberbenefits", "params": [ { "name": "memberId", "value": "500123", "type": "path" } ] }, "docs": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_member_benefits.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_member_benefits.htm)" } ] }, { "info": { "name": "Member", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Member Profile", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/loyalty-programs/:loyaltyProgramName/members", "params": [ { "name": "memberId", "value": "500123", "type": "query", "description": "The ID of the loyalty program member." }, { "name": "membershipNumber", "value": "example_value", "type": "query", "description": "The membership number of the loyalty program member." }, { "name": "programCurrencyName", "value": "example_value", "type": "query", "description": "The name of the loyalty program currency associated with the member.\nUse this parameter to get the details of the member’s points-related information for a specific currency." }, { "name": "loyaltyProgramName", "value": "example_value", "type": "path" } ] }, "docs": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_member_profile.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_member_profile.htm)" }, { "info": { "name": "Salesforce Member Vouchers", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/vouchers", "params": [ { "name": "loyaltyProgramName", "value": "example_value", "type": "path" }, { "name": "membershipNumber", "value": "example_value", "type": "path" } ] }, "docs": "[Member Vouchers](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_member_vouchers.htm)\n\nNOTE:\n\nIn the Pre-request. Script Tab, make changes in the variables value accordingly with the real Process Name to invoke." } ] }, { "info": { "name": "Redeem", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Redeem Voucher", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/vouchers/:voucherCode/redeem", "params": [ { "name": "voucherNumber", "value": "example_value", "type": "query" }, { "name": "loyaltyProgramName", "value": "example_value", "type": "path", "description": "The loyalty program name." }, { "name": "membershipNumber", "value": "example_value", "type": "path", "description": "The loyalty program membership number." }, { "name": "voucherCode", "value": "example_value", "type": "path", "description": "The voucher code to be redeemed." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_redeem_voucher.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_redeem_voucher.htm)" } ] }, { "info": { "name": "History", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Transaction History", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/loyalty/programs/:loyaltyProgramName/transaction-history", "params": [ { "name": "page", "value": "example_value", "type": "query" }, { "name": "loyaltyProgramName", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_history.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_history.htm)" } ] }, { "info": { "name": "Summaries", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Transaction Ledger Summary", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/transaction-ledger-summary", "params": [ { "name": "loyaltyProgramName", "value": "example_value", "type": "path" }, { "name": "membershipNumber", "value": "example_value", "type": "path" } ] }, "docs": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_ledger.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_ledger.htm)" } ] }, { "info": { "name": "Execution", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Transaction Journals Execution", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/realtime/loyalty/programs/:loyaltyProgramName", "params": [ { "name": "loyaltyProgramName", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_loyalty_program_realtime.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_loyalty_program_realtime.htm)" } ] }, { "info": { "name": "Cancel", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Cancel a Voucher", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/connect/loyalty/programs/:loyaltyProgramName/program-processes/:processName", "params": [ { "name": "loyaltyProgramName", "value": "example_value", "type": "path" }, { "name": "processName", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_cancel_voucher.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_cancel_voucher.htm)\n\nIn the Pre-request. Script Tab, make changes in the variables value accordingly with the real Process Name to invoke." } ] }, { "info": { "name": "Games", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Games", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/game/participant/:participantId/games", "params": [ { "name": "participantId", "value": "500123", "type": "path" } ] }, "docs": "[Games](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_gamification.htm)\n\nNOTE:\n\nIn the Pre-request. Script Tab, make changes in the variables value accordingly with the real Process Name to invoke." } ] }, { "info": { "name": "Game", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Game Reward", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/game/gameparticipantreward/:gameParticipantRewardId/game-reward", "params": [ { "name": "gameParticipantRewardId", "value": "500123", "type": "path" } ] }, "docs": "[Game Reward](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_game_result.htm)\n\nNOTE:\n\nIn the Pre-request. Script Tab, make changes in the variables value accordingly with the real Process Name to invoke." } ] }, { "info": { "name": "Eligible", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Eligible Promotions", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/global-promotions-management/eligible-promotions", "body": { "type": "json", "data": "{}" } }, "docs": "[Eligible Promotions](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_eligible_promotions.htm)\n\nNOTE:\n\nIn the Pre-request. Script Tab, make changes in the variables value accordingly with the real Process Name to invoke." } ] }, { "info": { "name": "Promotion", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Promotion Details", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/global-promotions-management/promotions/:promotionId", "params": [ { "name": "promotionId", "value": "500123", "type": "path" } ] }, "docs": "[Promotions Creation](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_unified_promotions.htm)\n\nNOTE:\n\nIn the Pre-request. Script Tab, make changes in the variables value accordingly with the real Process Name to invoke." } ] }, { "info": { "name": "Integration", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Integration Procedure Invocation Using Post", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/apexrest/:NAMESPACE/v1/integrationprocedure/:TYPE_SUBTYPE", "params": [ { "name": "NAMESPACE", "value": "example_value", "type": "path", "description": "The namespace is `omnistudio`, `vlocity_ins`, `vlocity_cmt`, or `vlocity_ps`" }, { "name": "TYPE_SUBTYPE", "value": "example_value", "type": "path", "description": "Type and SubType of the Integration Procedure separated by an underscore." } ] }, "docs": "Salesforce Integration Procedure Invocation Using Post" } ] }, { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Accounts", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/graphql", "headers": [ { "name": "X-Chatter-Entity-Encoding", "value": "true" } ] }, "docs": "Salesforce Accounts" } ] }, { "info": { "name": "Active", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get Active Theme", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/themes/active" }, "docs": "Get a Salesforce org’s active theme. A theme uses colors, images, and banners to change the overall appearance of Salesforce. Administrators can define themes and switch themes to provide a different look. The User Interface API response matches the Admin’s selection." } ] }, { "info": { "name": "Soap", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Soap Describemetadata", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/Soap/m/64.0", "headers": [ { "name": "Content-Type", "value": "example_value" }, { "name": "charset", "value": "example_value" }, { "name": "SOAPAction", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ] }, "docs": "Salesforce Soap Describemetadata" }, { "info": { "name": "Salesforce Soap Undelete", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/services/Soap/c/64.0", "headers": [ { "name": "Content-Type", "value": "example_value" }, { "name": "Accept", "value": "example_value" }, { "name": "SOAPAction", "value": "example_value" } ] }, "docs": "Undeletes records from the Recycle Bin." } ] }, { "info": { "name": "Actions", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Standard Invocable Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/actions/standard", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Returns the list of actions that can be statically invoked. You can also get basic information for each type of action.\nThis resource is available in REST API version 32.0 and later." }, { "info": { "name": "Salesforce Custom Invocable Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/actions/custom", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Returns the list of all custom actions. You can also get basic information for each type of action.\nThis resource is available in REST API version 32.0 and later." }, { "info": { "name": "Salesforce Quick Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/quickActions", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Returns a list of global actions and object-specific actions. This resource is available in REST API version 28.0 and later. When working with actions, also refer to SObject Quick Actions.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_quickactions.htm" }, { "info": { "name": "Salesforce Get Global Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/global" }, "docs": "Get the actions on record detail pages." }, { "info": { "name": "Salesforce Get Record Detail Page Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/record/:RECORD_IDS", "params": [ { "name": "RECORD_IDS", "value": "example_value", "type": "path", "description": "A single record ID, or a comma-delimited list of record IDs." } ] }, "docs": "Get the actions on record detail pages." }, { "info": { "name": "Salesforce Get Record Edit Page Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/record/:RECORD_ID/record-edit", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" } ] }, "docs": "Get the actions on record detail pages." }, { "info": { "name": "Salesforce Get Related List Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/record/:RECORD_ID/related-list/:RELATED_LIST_IDS", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" }, { "name": "RELATED_LIST_IDS", "value": "example_value", "type": "path", "description": "Optional. A related list name, or a comma-delimited list of related list names." } ] }, "docs": "Get the actions on record detail pages." }, { "info": { "name": "Salesforce Get Related List Record Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/record/:RECORD_ID/related-list-record/:RELATED_LIST_RECORD_IDS", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" }, { "name": "RELATED_LIST_RECORD_IDS", "value": "example_value", "type": "path", "description": "A related list record ID, or a comma-delimited list of related list record IDs." } ] }, "docs": "Get the actions on records in related lists." }, { "info": { "name": "Salesforce Get List View Header Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/list-view/:LIST_VIEW_IDS", "params": [ { "name": "LIST_VIEW_IDS", "value": "example_value", "type": "path", "description": "A single list view ID, or a comma-delimited list of list view IDs." } ] }, "docs": "Get the actions on records in related lists." }, { "info": { "name": "Salesforce Get List View Record Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/list-view-record/:RECORD_IDS", "params": [ { "name": "RECORD_IDS", "value": "example_value", "type": "path", "description": "A single record ID, or a comma-delimited list of record IDs." } ] }, "docs": "Get the record actions on list views." }, { "info": { "name": "Salesforce Get List View Chart Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/list-view-chart/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "Currently, only `ListViewChartInstance` is valid." } ] }, "docs": "Get the record actions on list views." }, { "info": { "name": "Salesforce Get Lightning Page Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/flexipage/:FLEXIPAGE_NAMES", "params": [ { "name": "FLEXIPAGE_NAMES", "value": "example_value", "type": "path", "description": "A Lightning page name, or a comma-delimited list of Lightning page names." } ] }, "docs": "Get the actions on Lightning pages (FlexiPages)." }, { "info": { "name": "Salesforce Get Lookup Field Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/lookup/:SOBJECT_API_NAMES", "params": [ { "name": "SOBJECT_API_NAMES", "value": "example_value", "type": "path", "description": "A lookup field name, or a comma-delimited list of lookup field names." } ] }, "docs": "Get the actions on Lightning pages (FlexiPages)." }, { "info": { "name": "Salesforce Get Mru List View Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/mru-list/:SOBJECT_API_NAMES", "params": [ { "name": "SOBJECT_API_NAMES", "value": "example_value", "type": "path", "description": "An object name, or a comma-delimited list of object names." } ] }, "docs": "Get the header actions on the most recently used (MRU) list view for objects." }, { "info": { "name": "Salesforce Get Photo Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/actions/photo/:RECORD_IDS", "params": [ { "name": "RECORD_IDS", "value": "example_value", "type": "path" } ] }, "docs": "Get the photo actions for pages. Currently, only group and user pages support photo actions." }, { "info": { "name": "Salesforce Sobject Quick Actions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/quickActions", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Returns a list of actions and their details. This resource is available in REST API version 28.0 and later. When working with actions, also refer to Quick Actions.\n\nTo return a specific object’s actions as well as global actions, use: /vXX.X/sobjects/object/quickActions/\nTo return a specific action, use /vXX.X/sobjects/object/quickActions/{action name}\nTo return a specific action’s descriptive detail, use /vXX.X/sobjects/object/quickActions/{action name}/describe/\nTo return a specific action’s d" } ] }, { "info": { "name": "Flow", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Launch Flow", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/actions/custom/flow/:flowApiName", "params": [ { "name": "flowApiName", "value": "example_value", "type": "path", "description": "Flow API Name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Launches an Autolaunched Flow with the supplied input parameters." } ] }, { "info": { "name": "Download", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Download File", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v54.0/sobjects/ContentVersion/0681k0000020wLFAAY/VersionData", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Lists the available objects and their metadata for your organization’s data. In addition, it provides the organization encoding, as well as the maximum batch size permitted in queries.\n\nYou can use the If-Modified-Since header with this resource, with the date format EEE, dd MMM yyyy HH:mm:ss z. When using this header, if no available object’s metadata has changed since the provided date, a 304 Not Modified status code is returned with no response body." } ] }, { "info": { "name": "Basic", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Sobject Basic Information", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Describes the individual metadata for the specified object. Can also be used to create a new record for a given object. For example, this can be used to retrieve the metadata for the Account object using the GET method, or create a new Account object using the POST method." } ] }, { "info": { "name": "Layouts", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Sobject Named Layouts", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/describe/namedLayouts/:LAYOUT_NAME", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "LAYOUT_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Retrieves information about alternate named layouts for a given object." }, { "info": { "name": "Salesforce Search Result Layouts", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/search/layout", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "q", "value": "example_value", "type": "query", "description": "Comma delimited object list" } ] }, "docs": "Returns search result layout information for the objects in the query string. For each object, this call returns the list of fields displayed on the search results page as columns, the number of rows displayed on the first page, and the label used on the search results page.\nThis call supports bulk fetch for up to 100 objects in a query.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_layouts.htm" } ] }, { "info": { "name": "Rows", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Sobject Rows", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/:RECORD_ID", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "RECORD_ID", "value": "500123", "type": "path" } ] }, "docs": "Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records." }, { "info": { "name": "Salesforce Sobject Rows Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/:RECORD_ID", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "RECORD_ID", "value": "500123", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records." } ] }, { "info": { "name": "External", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Sobject Rows by External Id", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/:FIELD_NAME/:FIELD_VALUE", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "FIELD_NAME", "value": "example_value", "type": "path" }, { "name": "FIELD_VALUE", "value": "example_value", "type": "path" } ] }, "docs": "Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.\n\nIf the specified value doesn't exist, a new record is created.\nIf a record does exist with that value, the field values specified in the request body are updated.\nIf the value is not unique, the REST API returns a 300 response with the list of matching records.\n\nHEAD, GET, PATCH, DELETE, POST" } ] }, { "info": { "name": "Blobs", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Sobject Blob Retrieve", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/:RECORD_ID/:BLOB_FIELD", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "RECORD_ID", "value": "500123", "type": "path" }, { "name": "BLOB_FIELD", "value": "example_value", "type": "path" } ] }, "docs": "Retrieves the specified blob field from an individual record." } ] }, { "info": { "name": "Image", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Sobject Rich Text Image Retrieve", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/:RECORD_ID/richTextImageFields/:FIELD_NAME/:CONTENT_REFERENCE_ID", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "RECORD_ID", "value": "500123", "type": "path" }, { "name": "FIELD_NAME", "value": "example_value", "type": "path" }, { "name": "CONTENT_REFERENCE_ID", "value": "500123", "type": "path" } ] }, "docs": "Retrieves the specified image data from a specific rich text area field in a given record.\ncontentReferenceId\tThe reference ID that uniquely identifies an image within a rich text area field.\nYou can obtain the reference by retrieving information for the object. The description will show the contents of the rich text area field" } ] }, { "info": { "name": "Relationships", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Sobject Relationships", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/:RECORD_ID/:RELATIONSHIP_FIELD_NAME", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "RECORD_ID", "value": "500123", "type": "path" }, { "name": "RELATIONSHIP_FIELD_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Accesses records by traversing object relationships via friendly URLs. You can retrieve, update, or delete the record associated with the traversed relationship field. If there are multiple related records, you can retrieve the complete set of associated records. This resource is available in REST API version 36.0 and later.\n\nGET, PATCH, DELETE" } ] }, { "info": { "name": "Suggested", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Sobject Suggested Articles", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/suggestedArticles", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "description", "value": "A sample description.", "type": "query" }, { "name": "language", "value": "example_value", "type": "query" }, { "name": "subject", "value": "example_value", "type": "query" }, { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Returns a list of suggested Salesforce Knowledge articles for a case, work order, or work order line item." } ] }, { "info": { "name": "Password", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Sobject User Password", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/User/:USER_ID/password", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "USER_ID", "value": "500123", "type": "path" } ] }, "docs": "Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later." }, { "info": { "name": "Salesforce Sobject Self Service User Password", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/SelfServiceUser/:USER_ID/password", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "USER_ID", "value": "500123", "type": "path" } ] }, "docs": "Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later." } ] }, { "info": { "name": "Compact", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Compact Layouts", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/compactLayouts", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "q", "value": "example_value", "type": "query", "description": "object list" } ] }, "docs": "Returns a list of compact layouts for multiple objects. This resource is available in REST API version 31.0 and later." } ] }, { "info": { "name": "Requests", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Request Openapi Schema", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/async/specifications/oas3" }, "docs": "Requests an Open API document for the selected SObject REST API resources." } ] }, { "info": { "name": "Lightning", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Lightning Toggle Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/LightningToggleMetrics", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Return details about users who switched between Salesforce Classic and Lightning Experience.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_togglemetrics.htm" }, { "info": { "name": "Salesforce Lightning Usage by Page", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/LightningUsageByBrowserMetrics", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Represents standard pages users viewed most frequently in Lightning Experience.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebypagemetrics.htm" }, { "info": { "name": "Salesforce Lightning Usage by Flexipage", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/LightningUsageByFlexiPageMetrics", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Return details about the custom pages viewed most frequently in Lightning Experience.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyflexipagemetrics.htm" } ] }, { "info": { "name": "Exit", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Lightning Exit by Page Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/LightningExitByPageMetrics", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Return frequency metrics about the standard pages within which users switched from Lightning Experience to Salesforce Classic.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_exitbypagemetrics.htm" } ] }, { "info": { "name": "Lists", "type": "folder" }, "items": [ { "info": { "name": "Salesforce List Views", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/listviews", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Returns the list of list views for the specified sObject, including the ID and other basic information about each list view. You can also get basic information for a specific list view by ID." }, { "info": { "name": "Salesforce List View Results", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/listviews/:LIST_VIEW_ID/results", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "LIST_VIEW_ID", "value": "500123", "type": "path" } ] }, "docs": "Returns detailed information about a list view, including the ID, the columns, and the SOQL query." }, { "info": { "name": "Salesforce Articles List", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/support/knowledgeArticles", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Get a page of online articles for the given language and category through either search or query." } ] }, { "info": { "name": "Items", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Recently Viewed Items", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/:SOBJECT_API_NAME/listviews/recent", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "limit", "value": "example_value", "type": "query" }, { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Gets the most recently accessed items that were viewed or referenced by the current user. Salesforce stores information about record views in the interface and uses it to generate a list of recently viewed and referenced records, such as in the sidebar and for the auto-complete options in search.\n\nThis resource only accesses most recently used item information. If you want to modify the list of recently viewed items, you’ll need to update recently viewed information directly by using a SOQL Quer" }, { "info": { "name": "Salesforce Relevant Items", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/relevantItems", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Gets the current user’s most relevant items. Relevant items include records for objects in the user’s global search scope and also most recently used (MRU) objects.\nRelevant items include up to 50 of the most recently viewed or updated records for each object in the user’s global search scope.\nNote\nThe user’s global search scope includes the objects the user interacted with most in the last 30 days, including objects the user pinned from the search results page in the Salesforce Classic.\n\nThen, " }, { "info": { "name": "Salesforce Update Personalized Navigation Items", "type": "http" }, "http": { "method": "PUT", "url": "https://login.salesforce.com/data/v64.0/ui-api/apps/:APP_ID/user-nav-items", "params": [ { "name": "APP_ID", "value": "500123", "type": "path", "description": "Application ID" } ] }, "docs": "Updates the order of a user’s personalized navigation items (tabs) and adds a navigation item to the list in the order specified." } ] }, { "info": { "name": "Scheduling", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Scheduling", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/scheduling", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Return frequency metrics about the standard pages within which users switched from Lightning Experience to Salesforce Classic.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_exitbypagemetrics.htm" } ] }, { "info": { "name": "Appointment", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get Appointment Slots", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/scheduling/getAppointmentSlots", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a list of available appointment time slots for a resource based on given work type group and territories.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_ls_getappointmentslots.htm" }, { "info": { "name": "Salesforce Get Appointment Candidates", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/scheduling/getAppointmentCandidates", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a list of available service resources (appointment candidates) based on work type group and service territories.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_ls_getappointmentcandidates.htm" } ] }, { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Search", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/search", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "q", "value": "example_value", "type": "query", "description": "A SOSL statement that is properly URL-encoded." } ] }, "docs": "Executes the specified SOSL search. The search string must be URL-encoded.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search.htm" }, { "info": { "name": "Salesforce Parameterized Search", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/parameterizedSearch", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "q", "value": "example_value", "type": "query", "description": "A search string that is properly URL-encoded" } ] }, "docs": "Executes a simple RESTful search using parameters instead of a SOSL clause. Indicate parameters in a URL in the GET method. Or, use POST for more complex JSON searches." }, { "info": { "name": "Salesforce Tooling Search", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/search", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "q", "value": "example_value", "type": "query", "description": "SOSL search statement" } ] }, "docs": "Runs one or more methods within one or more Apex classes, using the asynchronous test execution mechanism. In the request body, you can specify test class names and IDs, suite names and IDs, the maximum number of failed tests to allow, and the test level, as comma-separated lists or as an array. You can also indicate whether to opt out of collecting code coverage information during the test run (available in API version 43.0 and later)." } ] }, { "info": { "name": "Order", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Search Scope and Order", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/search/scopeOrder", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Returns an ordered list of objects in the default global search scope of a logged-in user. Global search keeps track of which objects the user interacts with and how often and arranges the search results accordingly. Objects used most frequently appear at the top of the list.\nThe returned list reflects the object order in the user’s default search scope, including any pinned objects on the user’s search results page. This call is useful if you want to implement a custom search results page using" } ] }, { "info": { "name": "Instant", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Search for Records Suggested by Autocomplete and Instant Results", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/search/suggestions", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "q", "value": "example_value", "type": "query" }, { "name": "sobject", "value": "example_value", "type": "query" } ] }, "docs": "Returns a list of suggested records whose names match the user’s search string. The suggestions resource provides autocomplete results and instant results for users to navigate directly to likely relevant records, before performing a full search.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_records.htm" } ] }, { "info": { "name": "Queries", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Search Suggested Queries", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/search/suggestSearchQueries", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "q", "value": "example_value", "type": "query" }, { "name": "language", "value": "example_value", "type": "query" } ] }, "docs": "Returns a list of suggested searches based on the user’s query string text matching searches that other users have performed in Salesforce Knowledge. Provides a way to improve search effectiveness, before the user performs a search.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_queries.htm" } ] }, { "info": { "name": "Approvals", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Process Approvals", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/process/approvals", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Returns a list of all approval processes. Can also be used to submit a particular record if that entity supports an approval process and one has already been defined. Records can be approved and rejected if the current user is an assigned approver. When using a POST request to do bulk approvals, the requests that succeed are committed and the requests that don’t succeed send back an error.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_process_approvals.htm" }, { "info": { "name": "Salesforce Process Approvals Submit", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/process/approvals", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a list of all approval processes. Can also be used to submit a particular record if that entity supports an approval process and one has already been defined. Records can be approved and rejected if the current user is an assigned approver. When using a POST request to do bulk approvals, the requests that succeed are committed and the requests that don’t succeed send back an error.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_process_approvals.htm" } ] }, { "info": { "name": "Process", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Process Rules", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/process/rules", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Returns a list of all active workflow rules. If a rule has actions, the actions will be listed under the rule. Can also be used to trigger all workflow rules that are associated with a specified record. The actions for a rule are only fired if the rule’s criteria is met. When using a POST request, if anything fails, the whole transaction is rolled back.\n\nCross-object workflow rules cannot be invoked using the REST API.\n\nTo get a list of the workflow rules or to trigger one or more workflow rules" } ] }, { "info": { "name": "Knowledge", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Retrieve Knowledge Language Settings", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/knowledgeManagement/settings", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Returns the existing Knowledge language settings, including the default knowledge language and a list of supported Knowledge language information.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_knowledge_retrieve_language.htm" } ] }, { "info": { "name": "Rest", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Apex Rest", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/apexrest/:urlMapping", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "urlMapping", "value": "https://www.example.com", "type": "path", "description": "Value of `urlMapping` as defined in `@RestResource` annotation in the Apex class." } ] }, "docs": "Gets the list of icons and colors used by themes in the Salesforce application. Theme information is provided for objects in your organization that use icons and colors in the Salesforce UI.\n\nThe If-Modified-Since header can be used with this resource, with a date format of EEE, dd MMM yyyy HH:mm:ss z. When this header is used, if the object metadata has not changed since the provided date, a 304 Not Modified status code is returned, with no response body.\n\nhttps://developer.salesforce.com/docs/" } ] }, { "info": { "name": "Versions", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Versions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data", "headers": [ { "name": "Content-Type", "value": "example_value" }, { "name": "Sforce-Call-Options", "value": "example_value" } ] }, "docs": "Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version's root." } ] }, { "info": { "name": "Consent", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Consent", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/consent/action/action", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "actions", "value": "example_value", "type": "query" }, { "name": "ids", "value": "example_value", "type": "query" } ] }, "docs": "Your users can store consent preferences in different locations and possibly inconsistently. You can locate your customers’ preferences for consent across multiple records when using API version 44.0 and later. Tracking consent preferences helps you and your users respect the most restrictive requests.\nConsent API aggregates consent settings across the Contact, Contact Point Type Consent, Data Use Purpose, Individual, Lead, Person Account, and User objects when the records have a lookup relation" } ] }, { "info": { "name": "Product", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Product Schedules", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/sobjects/OpportunityLineItem/:OPPORTUNITY_LINE_ITEM_ID/OpportunityLineItemSchedules", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "OPPORTUNITY_LINE_ITEM_ID", "value": "500123", "type": "path" } ] }, "docs": "Work with revenue and quantity schedules for opportunity products. Establish or reestablish a product schedule with multiple installments for an opportunity product. Delete all installments in a schedule.\nThis resource is available in REST API version 43.0 and later.\n\nIn API version 46.0 and later, established and re-established schedules support custom fields, validation rules, and Apex triggers. Deleting all schedules now also fires delete triggers.\nhttps://developer.salesforce.com/docs/atlas." } ] }, { "info": { "name": "Count", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Record Count", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/limits/recordCount", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "sObjects", "value": "example_value", "type": "query", "description": "A comma-delimited list of object names. If a listed object is not found in the org, it is ignored and not returned in the response.\nThis parameter is optional. If this parameter is not provided, the resource returns record counts for all objects in the org." } ] }, "docs": "Lists information about object record counts in your organization.\nThis resource is available in REST API version 40.0 and later for API users with the “View Setup and Configuration” permission. The returned record count is approximate, and does not include the following types of records:\n\nDeleted records in the recycle bin.\nArchived records.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_record_count.htm" } ] }, { "info": { "name": "Tabs", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Tabs", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tabs", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "f a survey field can be translated or is already translated into a particular language, you can add or change the translated value of the survey field.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/request_survey_translate_add_change.htm" } ] }, { "info": { "name": "Themes", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Themes", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/theme", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Gets the list of icons and colors used by themes in the Salesforce application. Theme information is provided for objects in your organization that use icons and colors in the Salesforce UI.\n\nThe If-Modified-Since header can be used with this resource, with a date format of EEE, dd MMM yyyy HH:mm:ss z. When this header is used, if the object metadata has not changed since the provided date, a 304 Not Modified status code is returned, with no response body.\n\nhttps://developer.salesforce.com/docs/" } ] }, { "info": { "name": "Info", "type": "folder" }, "items": [ { "info": { "name": "Salesforce User Info", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/oauth2/userinfo", "headers": [ { "name": "Content-Type", "value": "example_value" } ] }, "docs": "Salesforce User Info" } ] }, { "info": { "name": "Bundles", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Request Product Information (no Bundles)", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/commerce/catalog-products/actions/get-products", "body": { "type": "json", "data": "{}" } }, "docs": "Request information for two products that aren't bundles. For the first product, request only the information about the specified product selling model. For the second product, request information about all related product selling models.\n\nSee [Request Product Information](https://desktop.postman.com/?desktopVersion=10.13.6&webVersion=10.13.7-ui-230522-1730&userId=10709048&teamId=0)." } ] }, { "info": { "name": "Calculate", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Calculate Price (new Sale)", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/commerce/pricing/salestransaction/actions/calculate-price", "body": { "type": "json", "data": "{}" } }, "docs": "Calculate the price of a new sale that contains two order items: a term-defined subscription order for a bronze-level SLA, and an evergreen subscription order for a virtual router. The payload for the term-defined order contains both a start date and an end date. Instead of an end date, you can also include a start date and a subscription term.\n\nSee [Calculate Price](https://developer.salesforce.com/docs/revenue/subscription-management/references/prices?meta=Summary)." } ] }, { "info": { "name": "Initiate", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Initiate Cancellation", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/asset-management/assets/collection/actions/initiate-cancellation", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Initiate Cancellation" }, { "info": { "name": "Salesforce Initiate Renewal", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/asset-management/assets/collection/actions/initiate-renewal", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Initiate Renewal" } ] }, { "info": { "name": "Amend", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Initiate Amend Quantity", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/asset-management/assets/collection/actions/initiate-amend-quantity", "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Initiate Amend Quantity" } ] }, { "info": { "name": "Sandbox", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Create/clone Sandbox", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/SandboxInfo", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or clones a sandbox. If you wish to clone, fill the SourceId body field with the org Id of the source sandbox." } ] }, { "info": { "name": "Refresh", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Refresh Sandbox", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID", "params": [ { "name": "SANDBOX_INFO_ID", "value": "500123", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Refreshes a sandbox." } ] }, { "info": { "name": "Completion", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Tooling Completion", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/completions", "headers": [ { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "type", "value": "example_value", "type": "query", "description": "apex or visualforce" } ] }, "docs": "Retrieves available code completions of the referenced type for Apex system method symbols (type=apex). Available from API version 28.0 or later." } ] }, { "info": { "name": "Async", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Tooling Run Tests Async", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/tooling/runTestsAsynchronous", "body": { "type": "json", "data": "{}" } }, "docs": "Runs one or more methods within one or more Apex classes, using the asynchronous test execution mechanism. In the request body, you can specify test class names and IDs, suite names and IDs, the maximum number of failed tests to allow, and the test level, as comma-separated lists or as an array. You can also indicate whether to opt out of collecting code coverage information during the test run (available in API version 43.0 and later)." } ] }, { "info": { "name": "Runs", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Tooling Run Tests Sync", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/tooling/runTestsSynchronous", "body": { "type": "json", "data": "{}" } }, "docs": "Runs one or more methods within one or more Apex classes, using the asynchronous test execution mechanism. In the request body, you can specify test class names and IDs, suite names and IDs, the maximum number of failed tests to allow, and the test level, as comma-separated lists or as an array. You can also indicate whether to opt out of collecting code coverage information during the test run (available in API version 43.0 and later)." } ] }, { "info": { "name": "Post", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Post Tooling Sobject", "type": "http" }, "http": { "method": "POST", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Salesforce Post Tooling Sobject" } ] }, { "info": { "name": "Access", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Access Records", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/tooling/sobjects/:SOBJECT_API_NAME/:RECORD_ID", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "RECORD_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Access Records" } ] }, { "info": { "name": "Directories", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get a Directory of Supported Objects", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/object-info" }, "docs": "Get a Salesforce org’s active theme. A theme uses colors, images, and banners to change the overall appearance of Salesforce. Administrators can define themes and switch themes to provide a different look. The User Interface API response matches the Admin’s selection." } ] }, { "info": { "name": "Field", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get Values for a Picklist Field", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/object-info/:SOBJECT_API_NAME/picklist-values/:RECORD_TYPE_ID/:FIELD_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "Object API Name" }, { "name": "RECORD_TYPE_ID", "value": "500123", "type": "path", "description": "Record type Id. Use `012000000000000AAA` as default when there are no custom record types." }, { "name": "FIELD_API_NAME", "value": "example_value", "type": "path", "description": "Field API Name (optional)" } ] }, "docs": "Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme." }, { "info": { "name": "Salesforce Get Lookup Field Suggestions", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/lookups/:SOBJECT_API_NAME/:FIELD_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "sObject API name" }, { "name": "FIELD_API_NAME", "value": "example_value", "type": "path", "description": "Field API name" } ] }, "docs": "When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups." }, { "info": { "name": "Salesforce Get Lookup Field Suggestions for a Specified Object", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/lookups/:SOBJECT_API_NAME/:FIELD_API_NAME/:TARGET_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "The API name of a source object." }, { "name": "FIELD_API_NAME", "value": "example_value", "type": "path", "description": "The API name of a lookup field on the source object." }, { "name": "TARGET_API_NAME", "value": "example_value", "type": "path", "description": "The API name of the target (lookup) object." } ] }, "docs": "When a user edits a lookup field, use this resource to search for and display suggestions for a specified object. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups." } ] }, { "info": { "name": "Child", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get Child Records", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/records/:RECORD_ID/child-relationships/:RELATIONSHIP_NAME", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" }, { "name": "RELATIONSHIP_NAME", "value": "example_value", "type": "path", "description": "API name of the relationship" } ] }, "docs": "Get child records for a specified record and child relationship name. Relationships are connections between records. On a record detail page, each record in a related list has a child relationship to the parent record." } ] }, { "info": { "name": "Record", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Update a Record", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/ui-api/records/:RECORD_ID", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a record's data.\nUser Interface API enforces Salesforce validation rules. If a validation rule fails, the response is an Error with Output.\n\nWhen you make a PATCH request to update a record, make sure that the record hasn’t changed since the user started editing it. To find out whether it’s safe to save a record, pass the If-Modified-Since HTTP header in the request.\n\nAs of API version 43.0, if you pass read-only fields in a request body, the response is an Error with Output." } ] }, { "info": { "name": "Clone", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get Default Values to Clone a Record", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/record-defaults/clone/:RECORD_ID", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" } ] }, "docs": "Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.\nThe response contains the default field values for a record cloned from the record specified in , optionally of the specified recordTypeId.\n\nIt also contains the corresponding layout information for edit mode. In the Salesforce user interface, an admin with “Customize Application” permission can mark a fie" } ] }, { "info": { "name": "Favorite", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get a Favorite", "type": "http" }, "http": { "method": "GET", "url": "https://login.salesforce.com/data/v64.0/ui-api/favorites/:FAVORITE_ID", "params": [ { "name": "FAVORITE_ID", "value": "500123", "type": "path", "description": "The ID of a favorite" } ] }, "docs": "Get a favorite." }, { "info": { "name": "Salesforce Update a Favorite", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/ui-api/favorites/:FAVORITE_ID", "params": [ { "name": "FAVORITE_ID", "value": "500123", "type": "path", "description": "The ID of a favorite" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Favorite" }, { "info": { "name": "Salesforce Update Usage of a Favorite", "type": "http" }, "http": { "method": "PATCH", "url": "https://login.salesforce.com/data/v64.0/ui-api/favorites/:FAVORITE_ID/usage", "params": [ { "name": "FAVORITE_ID", "value": "500123", "type": "path", "description": "The ID of a favorite" } ] }, "docs": "Update the usage of an individual favorite, for example, the last time and number of times the favorite was clicked." } ] } ], "bundled": true }