{ "info": { "name": "Connect API Postman Collection", "description": "The Salesforce Platform APIs collection contains 250+ requests and example responses for the following APIs:\n\n
Auth
Bulk (v1 & v2)
Composite
Connect
CPQ
Einstein Prediction Service
Event Platform
GraphQL
Loyalty Management
Metadata
REST
Subscription Management
Tooling
UI
\n\n**⚠️ Disclaimer:** this collection is not covered by Salesforce support and SLAs.\n\n## Get Started\n\nClick the button below and follow the instructions from the following sections: \n[\"Run](https://god.gw.postman.com/run-collection/12721794-67cb9baa-e0da-4986-957e-88d8734647e2?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D12721794-67cb9baa-e0da-4986-957e-88d8734647e2%26entityType%3Dcollection%26workspaceId%3D34382471-0c97-40e5-a206-f947271665c4)\n\n### New Salesforce Users\n\nIf you are new to Salesforce, start by obtaining a free [Developer Edition Org](https://developer.salesforce.com/signup) then, follow the rest of the instructions from this documentation.\n\nYou can also watch our [Beginner's Mind YouTube series](https://www.youtube.com/playlist?list=PLgIMQe2PKPSKJ33M6CX-VLvgax7Xptcmz) for a tour of the Salesforce Platform (the last episode focuses on APIs).\n\n### New Postman Users\n\n

If you are new to Postman, complete this Trailhead project to setup the collection: Quick Start: Connect Postman to Salesforce.

\"\"

If you want to learn more about Postman in general, you can also complete this optional Trailhead badge: Postman API Client.

\"\"
\n\n### Regular Postman Users\n\nIf you are already familiar with Postman, here are the minimal getting started steps:\n\n1. If using Postman Web UI, follow these [steps to set up CORS](https://github.com/forcedotcom/postman-salesforce-apis/blob/master/install-with-web.md#enable-cors-in-salesforce) in your Salesforce Org. This is not required when working with the Postman Desktop app.\n \n2. Assign the following value to the `clientId` collection variable (this is a temporary step due to a Postman bug):\n\n```\n{{vault:salesforce-consumer-key}}\n```\n \n3. Assign a value to the `url` collection variable based on your Salesforce Org type:\n \n | URL | Org Type |\n | --- | --- |\n | `https://test.salesforce.com` | Sandboxes or Scratch orgs. |\n | `https://login.salesforce.com` | Production, Trailhead Playground and Developer Edition orgs. |\n | Custom My Domain base URL | Org with a custom domain. |\n \n4. Click **Get New Access Token** from the collection's **Authorization** tab.\n \n5. When prompted to do so, log in to your Salesforce org and allow access to \"Salesforce APIs Collection for Postman\".\n \n6. Copy the value of the `instance_url` field from the token details view.\n \n7. Click **Use Token**.\n \n8. Save the value that you copied in the `_endpoint` variable.\n \n9. Click **Save** and you're good to go!\n \n\n## Resources\n\nCheck out [the documentation](https://github.com/forcedotcom/postman-salesforce-apis) for videos and extra information on how to install, update and contribute to the collection.\n\nWe also have an [demo video](https://www.youtube.com/watch?v=W-IwW6RM4F0) on how to setup the collection.\n\n\n\nReport issues and ask questions [here](https://github.com/forcedotcom/postman-salesforce-apis/issues).\n\n## Variables Reference\n\nThe collection relies on the following variables:\n\n| Variable | Description |\n| --- | --- |\n| `_endpoint` | Your Salesforce Org's instance URL. |\n| `url` | The URL used for logging in. Either:
\\- `https://test.salesforce.com` for sandboxes or Scratch orgs
\\- `https://login.salesforce.com` for production, Trailhead Playground and Developer Edition orgs
\\- your custom My Domain base URL. |\n| `version` | The Salesforce API version (e.g.: 50.0). |\n| `username` | Your username. |\n| `password` | Your password. |\n| `secretToken` | Your personal [security token](https://help.salesforce.com/articleView?id=user_security_token.htm). |\n| `clientId` | Connected App client Id. |\n| `clientSecret` | Connected App client secret. |\n| `redirectUrl` | Connected App redirect URL for OAuth 2.0. |\n| `initAccessToken` | Initial access token for dynamic Connected App registration. |\n| `site` | Community suffix when connecting with an Experience Cloud user. |\n\nOnly a few of these variables are mandatory. The authentication requests will automatically register and set extra \"private\" variables identified with a `_` prefix (e.g.: `_accessToken`, `_orgId`, `_userId`...).\n\nExtracted from tests/contract/salesforce.postman_collection.json for connect_api.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "3724683", "_collection_link": "https://go.postman.co/collection/3724683-db7b315f-fcf0-460f-acbc-3ceca85d09a6?source=collection_link" }, "item": [ { "name": "Connect", "item": [ { "name": "File", "item": [ { "name": "Users Files, General", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "fileData", "type": "file", "value": null } ] }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/users/me", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "files", "users", "me" ] }, "description": "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 can also send the information as request parameters. For information about how to create the multipart/form-data message, see Uploading Binary Files.\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_users_files_general.htm" }, "response": [ { "name": "Successful Users Files, General", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "fileData", "type": "file", "src": "/Users/scolladon/Downloads/1x1.png" } ] }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/users/me", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "files", "users", "me" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:28:22 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"checksum\": \"71a50dbba44c78128b221b7df7bb51f1\",\n \"contentHubRepository\": null,\n \"contentModifiedDate\": \"2023-11-20T16:28:22.000Z\",\n \"contentSize\": 95,\n \"contentUrl\": null,\n \"contentVersionId\": \"068xx0000004C92AAE\",\n \"createdDate\": \"2023-11-20T16:28:22.000Z\",\n \"description\": null,\n \"downloadUrl\": \"/services/data/v58.0/connect/files/069.../content?versionNumber=1\",\n \"externalDocumentUrl\": null,\n \"externalFilePermissionInformation\": null,\n \"fileAsset\": null,\n \"fileExtension\": \"png\",\n \"fileType\": \"Png\",\n \"flashRenditionStatus\": \"Na\",\n \"id\": \"069...\",\n \"isFileAsset\": false,\n \"isInMyFileSync\": false,\n \"isMajorVersion\": true,\n \"mimeType\": \"image/png\",\n \"moderationFlags\": null,\n \"modifiedDate\": \"2023-11-20T16:28:22.000Z\",\n \"motif\": {\n \"color\": \"939393\",\n \"largeIconUrl\": \"/img/content/content64.png\",\n \"mediumIconUrl\": \"/img/content/content32.png\",\n \"smallIconUrl\": \"/img/icon/files16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"1x1.png\",\n \"origin\": \"Chatter\",\n \"owner\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"pageCount\": 0,\n \"parentFolder\": null,\n \"pdfRenditionStatus\": \"Na\",\n \"publishStatus\": \"PrivateAccess\",\n \"renditionUrl\": \"/services/data/v58.0/connect/files/069.../rendition?type=THUMB120BY90\",\n \"renditionUrl240By180\": \"/services/data/v58.0/connect/files/069.../rendition?type=THUMB240BY180\",\n \"renditionUrl720By480\": \"/services/data/v58.0/connect/files/069.../rendition?type=THUMB720BY480\",\n \"repositoryFileId\": null,\n \"repositoryFileUrl\": null,\n \"sharingOption\": \"Allowed\",\n \"sharingPrivacy\": \"None\",\n \"sharingRole\": \"Owner\",\n \"systemModstamp\": \"2023-11-20T16:28:23.000Z\",\n \"textPreview\": null,\n \"thumb120By90RenditionStatus\": \"NotScheduled\",\n \"thumb240By180RenditionStatus\": \"NotScheduled\",\n \"thumb720By480RenditionStatus\": \"NotScheduled\",\n \"title\": \"1x1.png\",\n \"topics\": {\n \"currentPageUrl\": null,\n \"nextPageUrl\": null,\n \"topics\": []\n },\n \"type\": \"File\",\n \"url\": \"/services/data/v58.0/connect/files/069...?versionNumber=1\",\n \"versionNumber\": \"1\"\n}" } ] }, { "name": "File Information", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "files", ":FILE_ID" ], "variable": [ { "key": "FILE_ID", "value": "" } ] }, "description": "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 file, including references to external files.\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_information.htm" }, "response": [ { "name": "File Information", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "files", ":FILE_ID" ], "variable": [ { "key": "FILE_ID", "value": "0692o00000woaKjAAI" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:33:38 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"checksum\": \"71a50dbba44c78128b221b7df7bb51f1\",\n \"contentHubRepository\": null,\n \"contentModifiedDate\": \"2023-11-20T16:28:22.000Z\",\n \"contentSize\": 95,\n \"contentUrl\": null,\n \"createdDate\": \"2023-11-20T16:28:22.000Z\",\n \"description\": null,\n \"downloadUrl\": \"/services/data/v58.0/connect/files/069.../content?versionNumber=1\",\n \"externalDocumentUrl\": null,\n \"externalFilePermissionInformation\": null,\n \"fileAsset\": null,\n \"fileExtension\": \"png\",\n \"fileType\": \"Png\",\n \"flashRenditionStatus\": \"Na\",\n \"id\": \"069...\",\n \"isFileAsset\": false,\n \"isInMyFileSync\": false,\n \"isMajorVersion\": true,\n \"mimeType\": \"image/png\",\n \"moderationFlags\": null,\n \"modifiedDate\": \"2023-11-20T16:28:22.000Z\",\n \"motif\": {\n \"color\": \"939393\",\n \"largeIconUrl\": \"/img/content/content64.png\",\n \"mediumIconUrl\": \"/img/content/content32.png\",\n \"smallIconUrl\": \"/img/icon/files16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"1x1.png\",\n \"origin\": \"Chatter\",\n \"owner\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"firstName\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"pageCount\": 0,\n \"parentFolder\": null,\n \"pdfRenditionStatus\": \"Na\",\n \"publishStatus\": \"PrivateAccess\",\n \"renditionUrl\": \"/services/data/v58.0/connect/files/069.../rendition?type=THUMB120BY90\",\n \"renditionUrl240By180\": \"/services/data/v58.0/connect/files/069.../rendition?type=THUMB240BY180\",\n \"renditionUrl720By480\": \"/services/data/v58.0/connect/files/069.../rendition?type=THUMB720BY480\",\n \"repositoryFileId\": null,\n \"repositoryFileUrl\": null,\n \"sharingOption\": \"Allowed\",\n \"sharingPrivacy\": \"None\",\n \"sharingRole\": \"Owner\",\n \"systemModstamp\": \"2023-11-20T16:28:23.000Z\",\n \"textPreview\": null,\n \"thumb120By90RenditionStatus\": \"NotScheduled\",\n \"thumb240By180RenditionStatus\": \"NotScheduled\",\n \"thumb720By480RenditionStatus\": \"NotScheduled\",\n \"title\": \"1x1.png\",\n \"topics\": {\n \"currentPageUrl\": null,\n \"nextPageUrl\": null,\n \"topics\": []\n },\n \"type\": \"File\",\n \"url\": \"/services/data/v58.0/connect/files/069...?versionNumber=1\",\n \"versionNumber\": \"1\"\n}" } ] }, { "name": "File Content", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID/content", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "files", ":FILE_ID", "content" ], "variable": [ { "key": "FILE_ID", "value": "" } ] }, "description": "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" }, "response": [] }, { "name": "File Information - Delete", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "files", ":FILE_ID" ], "variable": [ { "key": "FILE_ID", "value": "" } ] }, "description": "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 file, including references to external files.\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_files_information.htm" }, "response": [ { "name": "Successful File Information - Delete", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "files", ":FILE_ID" ], "variable": [ { "key": "FILE_ID", "value": "0692o00000woaRkAAI" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "plain", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:39:05 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Content-Security-Policy", "value": "upgrade-insecure-requests" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" } ], "cookie": [], "body": null } ] }, { "name": "File Shares", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID/file-shares", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "files", ":FILE_ID", "file-shares" ], "variable": [ { "key": "FILE_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Successful File Shares", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID/file-shares", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "files", ":FILE_ID", "file-shares" ], "variable": [ { "key": "FILE_ID", "value": "0692o00000woaRkAAI" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:37:07 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"currentPageUrl\": \"/services/data/v58.0/connect/files/069.../file-shares\",\n \"linkShare\": null,\n \"nextPageUrl\": null,\n \"previousPageUrl\": null,\n \"shares\": [\n {\n \"entity\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"firstName\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"sharingType\": \"I\"\n }\n ]\n}" } ] }, { "name": "Files Shares Link", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID/file-shares/link", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "files", ":FILE_ID", "file-shares", "link" ], "variable": [ { "key": "FILE_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Successful Files Shares Link", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/files/:FILE_ID/file-shares/link", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "files", ":FILE_ID", "file-shares", "link" ], "variable": [ { "key": "FILE_ID", "value": "0692o00000woaRkAAI" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:38:31 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"expirationDate\": null,\n \"fileViewUrl\": \"https:///sfc/p/2o000000i6mB/a/2o00000022S3/y2zsu9pHtEVIa49w6ElaXdjXz_GxBSzRVwe645_Z.dw\",\n \"isPasswordRequired\": false,\n \"password\": null,\n \"sharingType\": \"V\"\n}" } ] } ], "description": "Get information about files, including content and sharing. Post files, update files shares link." }, { "name": "Named Credential", "item": [ { "name": "Get Credential", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential?externalCredential=&principalName=&principalType=", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "credential" ], "query": [ { "key": "externalCredential", "value": "", "description": "Fully qualified developer name of the external credential." }, { "key": "principalName", "value": "", "description": "Name of the external credential named principal." }, { "key": "principalType", "value": "", "description": "Type of credential principal. Values are:\n* AwsStsPrincipal\n* NamedPrincipal\n* PerUserPrincipal" } ] }, "description": "Get a credential." }, "response": [ { "name": "Successful Get Credential", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential?externalCredential=Test&principalName=Test&principalType=NamedPrincipal", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "credential" ], "query": [ { "key": "externalCredential", "value": "Test", "description": "Fully qualified developer name of the external credential." }, { "key": "principalName", "value": "Test", "description": "Name of the external credential named principal." }, { "key": "principalType", "value": "NamedPrincipal", "description": "Type of credential principal. Values are:\n* AwsStsPrincipal\n* NamedPrincipal\n* PerUserPrincipal" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 12:01:04 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"authenticationProtocol\": \"Custom\",\n \"authenticationProtocolVariant\": \"NoAuthentication\",\n \"authenticationStatus\": \"Configured\",\n \"credentials\": {},\n \"externalCredential\": \"Test\",\n \"principalName\": \"Test\",\n \"principalType\": \"NamedPrincipal\"\n}" } ] }, { "name": "List External Credentials", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "external-credentials" ] }, "description": "Get external credentials that the user can authenticate to." }, "response": [ { "name": "Successful List External Credentials", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "external-credentials" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:46:27 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"externalCredentials\": [\n {\n \"authenticationProtocol\": \"Custom\",\n \"authenticationProtocolVariant\": \"NoAuthentication\",\n \"authenticationStatus\": \"NotConfigured\",\n \"customHeaders\": [],\n \"developerName\": \"Test\",\n \"id\": \"0pt...\",\n \"masterLabel\": \"Test\",\n \"parameters\": [],\n \"principals\": [],\n \"relatedNamedCredentials\": [\n {\n \"developerName\": \"Test\",\n \"id\": \"0XA...\",\n \"masterLabel\": \"Test\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/Test\"\n }\n ],\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/Test\"\n }\n ]\n}" } ] }, { "name": "List Named Credentials", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "named-credential-setup" ] }, "description": "Get a list of named credentials in the org." }, "response": [ { "name": "Successful List Named Credentials", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "named-credential-setup" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:45:55 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"namedCredentials\": [\n {\n \"calloutUrl\": \"https://my.example.com\",\n \"developerName\": \"Test\",\n \"id\": \"0XA...\",\n \"masterLabel\": \"Test\",\n \"type\": \"SecuredEndpoint\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/Test\"\n }\n ]\n}" } ] }, { "name": "Get External Credentials by Developer Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "external-credentials", ":DEVELOPER_NAME" ], "variable": [ { "key": "DEVELOPER_NAME", "value": "" } ] }, "description": "Get an external credential, including the named credentials and principals associated with it and the type and status of each principal." }, "response": [ { "name": "Successful Get External Credentials by Developer Name", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "external-credentials", ":DEVELOPER_NAME" ], "variable": [ { "key": "DEVELOPER_NAME", "value": "Test" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:49:36 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"authenticationProtocol\": \"Custom\",\n \"authenticationProtocolVariant\": \"NoAuthentication\",\n \"authenticationStatus\": \"NotConfigured\",\n \"customHeaders\": [],\n \"developerName\": \"Test\",\n \"id\": \"0pt...\",\n \"masterLabel\": \"Test\",\n \"parameters\": [],\n \"principals\": [],\n \"relatedNamedCredentials\": [\n {\n \"developerName\": \"Test\",\n \"id\": \"0XA...\",\n \"masterLabel\": \"Test\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/Test\"\n }\n ],\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/Test\"\n}" } ] }, { "name": "Get Named Credential by Developer Name", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "named-credential-setup", ":DEVELOPER_NAME" ], "variable": [ { "key": "DEVELOPER_NAME", "value": null } ] }, "description": "Get a named credential." }, "response": [ { "name": "Successful Get Named Credential by Developer Name", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "named-credential-setup", ":DEVELOPER_NAME" ], "variable": [ { "key": "DEVELOPER_NAME", "value": "Test" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:50:01 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": false,\n \"generateAuthorizationHeader\": true\n },\n \"calloutUrl\": \"https://my.example.com\",\n \"customHeaders\": [],\n \"developerName\": \"Test\",\n \"externalCredentials\": [\n {\n \"developerName\": \"Test\",\n \"id\": \"0pt...\",\n \"masterLabel\": \"Test\",\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/Test\"\n }\n ],\n \"id\": \"0XA...\",\n \"masterLabel\": \"Test\",\n \"parameters\": [],\n \"type\": \"SecuredEndpoint\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/Test\"\n}" } ] }, { "name": "Create Credential", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"authenticationProtocol\": \"Custom\",\n \"credentials\": {},\n \"externalCredential\": \"SampleExternalCredential\",\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "credential" ] }, "description": "Create a credential." }, "response": [ { "name": "successful Create Credential", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"authenticationProtocol\": \"Custom\",\n \"credentials\": {},\n \"externalCredential\": \"SampleExternalCredential\",\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "credential" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 12:06:08 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"authenticationProtocol\": \"Custom\",\n \"authenticationStatus\": \"Unknown\",\n \"credentials\": {},\n \"externalCredential\": \"SampleExternalCredential\",\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\"\n}" } ] }, { "name": "Create External Credential", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"developerName\": \"SampleExternalCredential\",\n \"masterLabel\": \"Sample External Credential\",\n \"authenticationProtocol\": \"Custom\",\n \"principals\": [\n {\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"sequenceNumber\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "external-credentials" ] }, "description": "Create an external credential." }, "response": [ { "name": "Successful Create External Credential", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"developerName\": \"SampleExternalCredential\",\n \"masterLabel\": \"Sample External Credential\",\n \"authenticationProtocol\": \"Custom\",\n \"principals\": [\n {\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"sequenceNumber\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "external-credentials" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:53:51 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"authenticationProtocol\": \"Custom\",\n \"authenticationStatus\": \"Unknown\",\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"id\": \"0pu2o000000KymkAAC\",\n \"sequenceNumber\": 1\n }\n ],\n \"developerName\": \"SampleExternalCredential\",\n \"id\": \"0pt2o000000CaU0AAK\",\n \"masterLabel\": \"Sample External Credential\",\n \"parameters\": [],\n \"principals\": [\n {\n \"authenticationStatus\": \"Unknown\",\n \"id\": \"0pu2o000000KymjAAC\",\n \"parameters\": [],\n \"principalAccess\": [],\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"relatedNamedCredentials\": [],\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n}" } ] }, { "name": "Create Named Credential", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"developerName\": \"SamplePrivate\",\n \"masterLabel\": \"SamplePrivateLabel\",\n \"type\": \"SecuredEndpoint\",\n \"calloutUrl\": \"https://api.example.com\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\"\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"sequenceNumber\": 1\n }\n ],\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "named-credential-setup" ] }, "description": "Create a named credential." }, "response": [ { "name": "Successful Create Named Credential", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"developerName\": \"SamplePrivate\",\n \"masterLabel\": \"SamplePrivateLabel\",\n \"type\": \"SecuredEndpoint\",\n \"calloutUrl\": \"https://api.example.com\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\"\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"sequenceNumber\": 1\n }\n ],\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "named-credential-setup" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:54:12 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n },\n \"calloutUrl\": \"https://api.example.com\",\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"id\": \"0pv2o000000PAv6AAG\",\n \"sequenceNumber\": 1\n }\n ],\n \"developerName\": \"SamplePrivate\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\",\n \"id\": \"0pt2o000000CaU0AAK\",\n \"masterLabel\": \"Sample External Credential\",\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n }\n ],\n \"id\": \"0XA2o000000XaAQGA0\",\n \"masterLabel\": \"SamplePrivateLabel\",\n \"parameters\": [],\n \"type\": \"SecuredEndpoint\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate\"\n}" } ] }, { "name": "Update Credential", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"externalCredential\": \"test\",\n \"authenticationProtocol\": \"Custom\",\n \"principalName\": \"test\",\n \"principalType\": \"NamedPrincipal\",\n \"credentials\": {\n \"testCredential\": {\n \"value\": \"000000\",\n \"encrypted\": true\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "credential" ] }, "description": "Update a credential." }, "response": [] }, { "name": "Update External Credential", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"masterLabel\": \"Sample External Credential\",\n \"authenticationProtocol\": \"Custom\",\n \"principals\": [\n {\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"sequenceNumber\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "external-credentials", ":DEVELOPER_NAME" ], "variable": [ { "key": "DEVELOPER_NAME", "value": "" } ] }, "description": "Update an external credential." }, "response": [ { "name": "Successful Update External Credential", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"masterLabel\": \"Sample External Credential\",\n \"authenticationProtocol\": \"Custom\",\n \"principals\": [\n {\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"sequenceNumber\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "external-credentials", ":DEVELOPER_NAME" ], "variable": [ { "key": "DEVELOPER_NAME", "value": "SampleExternalCredential" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:55:19 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"authenticationProtocol\": \"Custom\",\n \"authenticationStatus\": \"Unknown\",\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleHeaderValue\",\n \"id\": \"0pu2o000000KymkAAC\",\n \"sequenceNumber\": 1\n }\n ],\n \"developerName\": \"SampleExternalCredential\",\n \"id\": \"0pt2o000000CaU0AAK\",\n \"masterLabel\": \"Sample External Credential\",\n \"parameters\": [],\n \"principals\": [\n {\n \"authenticationStatus\": \"Unknown\",\n \"id\": \"0pu2o000000KymjAAC\",\n \"parameters\": [],\n \"principalAccess\": [],\n \"principalName\": \"SamplePrincipal\",\n \"principalType\": \"NamedPrincipal\",\n \"sequenceNumber\": 1\n }\n ],\n \"relatedNamedCredentials\": [\n {\n \"developerName\": \"SamplePrivate\",\n \"id\": \"0XA2o000000XaAQGA0\",\n \"masterLabel\": \"SamplePrivateLabel\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate\"\n }\n ],\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n}" } ] }, { "name": "Update Named Credential", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"masterLabel\": \"SamplePrivateLabel\",\n \"type\": \"SecuredEndpoint\",\n \"calloutUrl\": \"https://api.example.com\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\"\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"sequenceNumber\": 1\n }\n ],\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "named-credential-setup", ":DEVELOPER_NAME" ], "variable": [ { "key": "DEVELOPER_NAME", "value": "" } ] }, "description": "Update a named credential." }, "response": [ { "name": "Successful Update Named Credential", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"masterLabel\": \"SamplePrivateLabel\",\n \"type\": \"SecuredEndpoint\",\n \"calloutUrl\": \"https://api.example.com\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\"\n }\n ],\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"sequenceNumber\": 1\n }\n ],\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "named-credential-setup", ":DEVELOPER_NAME" ], "variable": [ { "key": "DEVELOPER_NAME", "value": "SamplePrivate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:54:57 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"calloutOptions\": {\n \"allowMergeFieldsInBody\": false,\n \"allowMergeFieldsInHeader\": true,\n \"generateAuthorizationHeader\": true\n },\n \"calloutUrl\": \"https://api.example.com\",\n \"customHeaders\": [\n {\n \"headerName\": \"SampleHeader\",\n \"headerValue\": \"SampleValue\",\n \"id\": \"0pv2o000000PAv6AAG\",\n \"sequenceNumber\": 1\n }\n ],\n \"developerName\": \"SamplePrivate\",\n \"externalCredentials\": [\n {\n \"developerName\": \"SampleExternalCredential\",\n \"id\": \"0pt2o000000CaU0AAK\",\n \"masterLabel\": \"Sample External Credential\",\n \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n }\n ],\n \"id\": \"0XA2o000000XaAQGA0\",\n \"masterLabel\": \"SamplePrivateLabel\",\n \"parameters\": [],\n \"type\": \"SecuredEndpoint\",\n \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate\"\n}" } ] }, { "name": "Delete Credential", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"externalCredential\": \"SampleExternalCredential\",\n \"principalType\": \"NamedPrincipal\",\n \"principalName\": \"SamplePrincipal\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/credential", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "credential" ] }, "description": "Delete a credential." }, "response": [] }, { "name": "Delete External Credential", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "external-credentials", ":DEVELOPER_NAME" ], "variable": [ { "key": "DEVELOPER_NAME", "value": "" } ] }, "description": "Delete an external credential." }, "response": [ { "name": "Successful Delete External Credential", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/external-credentials/:DEVELOPER_NAME", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "named-credentials", "external-credentials", ":DEVELOPER_NAME" ], "variable": [ { "key": "DEVELOPER_NAME", "value": "Test" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "plain", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 12:09:23 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Content-Security-Policy", "value": "upgrade-insecure-requests" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" } ], "cookie": [], "body": null } ] } ], "description": "Get, create, update, and delete a credential. Get the URL for the OAuth token flow for an external credential. Get external credentials.\n\n📚 [Named Credentials Resources in the Connect REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_named_credentials_resources.htm)" }, { "name": "Chatter", "item": [ { "name": "Feeds", "item": [ { "name": "News Feed Elements", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feeds/news/me/feed-elements", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feeds", "news", "me", "feed-elements" ] }, "description": "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" }, "response": [ { "name": "Successful News Feed Elements", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feeds/news/me/feed-elements", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feeds", "news", "me", "feed-elements" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:04:02 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feeds/news/005.../feed-elements\",\n \"elements\": [],\n \"isModifiedToken\": null,\n \"isModifiedUrl\": null,\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"updatesToken\": \"2:1700651042000\",\n \"updatesUrl\": \"/services/data/v58.0/chatter/feeds/news/005.../feed-elements?updatedSince=2%3A1700651042000\"\n}" } ] }, { "name": "User Profile Feed Elements", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feeds/user-profile/:USER_ID/feed-elements", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feeds", "user-profile", ":USER_ID", "feed-elements" ], "variable": [ { "key": "USER_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Successful User Profile Feed Elements", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feeds/user-profile/:USER_ID/feed-elements", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feeds", "user-profile", ":USER_ID", "feed-elements" ], "variable": [ { "key": "USER_ID", "value": "005..." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:04:39 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feeds/user-profile/005.../feed-elements\",\n \"elements\": [],\n \"isModifiedToken\": null,\n \"isModifiedUrl\": null,\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"updatesToken\": null,\n \"updatesUrl\": null\n}" } ] }, { "name": "Record Feed Elements", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feeds/record/:RECORD_GROUP_ID/feed-elements", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feeds", "record", ":RECORD_GROUP_ID", "feed-elements" ], "variable": [ { "key": "RECORD_GROUP_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Successful Record Feed Elements", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feeds/record/:RECORD_GROUP_ID/feed-elements", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feeds", "record", ":RECORD_GROUP_ID", "feed-elements" ], "variable": [ { "key": "RECORD_GROUP_ID", "value": "001..." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:05:44 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feeds/record/001.../feed-elements\",\n \"elements\": [],\n \"isModifiedToken\": null,\n \"isModifiedUrl\": null,\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"updatesToken\": \"2:1700651144000\",\n \"updatesUrl\": \"/services/data/v58.0/chatter/feeds/record/001.../feed-elements?updatedSince=2%3A1700651144000\"\n}" } ] } ], "description": "Feeds are made up of feed items. There are many feed types. Each feed type has an algorithm that determines which feed items it contains." }, { "name": "Feed Elements", "item": [ { "name": "Feed Elements, Post and Search", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feed-elements?feedElementType=FeedItem&subjectId=&text=New Feed Item", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feed-elements" ], "query": [ { "key": "feedElementType", "value": "FeedItem", "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." }, { "key": "subjectId", "value": "" }, { "key": "text", "value": "New Feed Item" } ] }, "description": "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" }, "response": [ { "name": "Successful Feed Elements, Post and Search", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feed-elements?feedElementType=FeedItem&subjectId=001...&text=New Feed Item", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feed-elements" ], "query": [ { "key": "feedElementType", "value": "FeedItem", "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." }, { "key": "subjectId", "value": "001..." }, { "key": "text", "value": "New Feed Item" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:06:07 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"actor\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"body\": {\n \"isRichText\": false,\n \"messageSegments\": [\n {\n \"text\": \"New Feed Item\",\n \"type\": \"Text\"\n }\n ],\n \"text\": \"New Feed Item\"\n },\n \"capabilities\": {\n \"associatedActions\": {\n \"platformActionGroups\": []\n },\n \"bookmarks\": {\n \"isBookmarkedByCurrentUser\": false\n },\n \"chatterLikes\": {\n \"isLikedByCurrentUser\": false,\n \"likesMessage\": null,\n \"myLike\": null,\n \"page\": {\n \"currentPageToken\": 0,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"close\": {\n \"canContextUserUpdateIsClosed\": true,\n \"isClosed\": false\n },\n \"comments\": {\n \"page\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"edit\": {\n \"isEditRestricted\": false,\n \"isEditableByMeUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/edit/is-editable-by-me\",\n \"lastEditedBy\": null,\n \"lastEditedDate\": null,\n \"latestRevision\": 1,\n \"relativeLastEditedDate\": null\n },\n \"interactions\": {\n \"count\": 0\n },\n \"mute\": {\n \"isMutedByMe\": false\n },\n \"readBy\": {\n \"isReadByMe\": true,\n \"lastReadDateByMe\": \"2023-11-22T11:06:07.000Z\",\n \"page\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/read-by/items?pageSize=3\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"status\": {\n \"feedEntityStatus\": \"Published\",\n \"isApprovableByMe\": true\n },\n \"topics\": {\n \"canAssignTopics\": true,\n \"items\": []\n },\n \"upDownVote\": {\n \"downVoteCount\": 0,\n \"myVote\": \"None\",\n \"upVoteCount\": 0\n }\n },\n \"clientInfo\": {\n \"applicationName\": \"Postman Playground\",\n \"applicationUrl\": null\n },\n \"createdDate\": \"2023-11-22T11:06:07.000Z\",\n \"event\": false,\n \"feedElementType\": \"FeedItem\",\n \"hasVerifiedComment\": false,\n \"header\": {\n \"isRichText\": null,\n \"messageSegments\": [\n {\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"reference\": {\n \"id\": \"005...\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\"\n },\n \"text\": \"Name\",\n \"type\": \"EntityLink\"\n }\n ],\n \"text\": \"Name\"\n },\n \"id\": \"0D5...\",\n \"isDeleteRestricted\": false,\n \"isSharable\": false,\n \"modifiedDate\": \"2023-11-22T11:06:07.000Z\",\n \"originalFeedItem\": null,\n \"originalFeedItemActor\": null,\n \"parent\": {\n \"entityLabel\": {\n \"label\": \"Account\",\n \"labelPlural\": \"Accounts\"\n },\n \"id\": \"001...\",\n \"motif\": {\n \"color\": \"5867E8\",\n \"largeIconUrl\": \"/img/icon/accounts64.png\",\n \"mediumIconUrl\": \"/img/icon/accounts32.png\",\n \"smallIconUrl\": \"/img/icon/accounts16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Burlington Textiles Corp of America\",\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/chatter/records/001...\"\n },\n \"photoUrl\": \"https:///profilephoto/729.../T\",\n \"relativeCreatedDate\": \"Just now\",\n \"type\": \"TextPost\",\n \"url\": \"/services/data/v58.0/chatter/feed-elements/0D5...\",\n \"visibility\": \"InternalUsers\"\n}" } ] }, { "name": "Feed Elements, Post and Search", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Chatter Feed Item Created via API: \"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupBegin\"\n },\n {\n \"markupType\" : \"Bold\",\n \"type\" : \"MarkupBegin\"\n },\n {\n \"text\" : \"First line of text.\",\n \"type\" : \"Text\"\n },\n {\n \"markupType\" : \"Bold\",\n \"type\" : \"MarkupEnd\"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupEnd\"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupBegin\"\n },\n {\n \"text\" : \" \",\n \"type\" : \"Text\"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupEnd\"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupBegin\"\n },\n {\n \"text\" : \"Second line of text.\",\n \"type\" : \"Text\"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupEnd\"\n },\n {\n \"markupType\" : \"Code\",\n \"type\" : \"MarkupBegin\"\n },\n {\n \"text\" : \"\",\n \"type\" : \"Text\"\n },\n {\n \"markupType\" : \"Code\",\n \"type\" : \"MarkupEnd\"\n },\n {\n \"type\": \"Mention\",\n \"id\": \"\"\n }\n ]\n },\n \"capabilities\": {\n \"files\": {\n \"items\": [\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"subjectId\": \"\",\n \"feedElementType\": \"FeedItem\"\n}" }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feed-elements", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feed-elements" ] }, "description": "https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_feed_element.htm\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_feed_element.htm" }, "response": [ { "name": "Successful Feed Elements, Post and Search", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Chatter Feed Item Created via API: \"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupBegin\"\n },\n {\n \"markupType\" : \"Bold\",\n \"type\" : \"MarkupBegin\"\n },\n {\n \"text\" : \"First line of text.\",\n \"type\" : \"Text\"\n },\n {\n \"markupType\" : \"Bold\",\n \"type\" : \"MarkupEnd\"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupEnd\"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupBegin\"\n },\n {\n \"text\" : \" \",\n \"type\" : \"Text\"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupEnd\"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupBegin\"\n },\n {\n \"text\" : \"Second line of text.\",\n \"type\" : \"Text\"\n },\n {\n \"markupType\" : \"Paragraph\",\n \"type\" : \"MarkupEnd\"\n },\n {\n \"markupType\" : \"Code\",\n \"type\" : \"MarkupBegin\"\n },\n {\n \"text\" : \"\",\n \"type\" : \"Text\"\n },\n {\n \"markupType\" : \"Code\",\n \"type\" : \"MarkupEnd\"\n },\n {\n \"type\": \"Mention\",\n \"id\": \"0052o00000DOJ1PAAX\"\n }\n ]\n },\n \"subjectId\": \"0012o00003PK8DSAA1\",\n \"feedElementType\": \"FeedItem\"\n}" }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feed-elements", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feed-elements" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:08:36 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"actor\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"body\": {\n \"isRichText\": true,\n \"messageSegments\": [\n {\n \"text\": \"Chatter Feed Item Created via API: \",\n \"type\": \"Text\"\n },\n {\n \"altText\": null,\n \"htmlTag\": \"p\",\n \"markupType\": \"Paragraph\",\n \"text\": \"\",\n \"type\": \"MarkupBegin\",\n \"url\": null\n },\n {\n \"altText\": null,\n \"htmlTag\": \"b\",\n \"markupType\": \"Bold\",\n \"text\": \"\",\n \"type\": \"MarkupBegin\",\n \"url\": null\n },\n {\n \"text\": \"First line of text.\",\n \"type\": \"Text\"\n },\n {\n \"htmlTag\": \"b\",\n \"markupType\": \"Bold\",\n \"text\": \"\",\n \"type\": \"MarkupEnd\"\n },\n {\n \"htmlTag\": \"p\",\n \"markupType\": \"Paragraph\",\n \"text\": \"\\n\",\n \"type\": \"MarkupEnd\"\n },\n {\n \"altText\": null,\n \"htmlTag\": \"p\",\n \"markupType\": \"Paragraph\",\n \"text\": \"\",\n \"type\": \"MarkupBegin\",\n \"url\": null\n },\n {\n \"text\": \" \",\n \"type\": \"Text\"\n },\n {\n \"htmlTag\": \"p\",\n \"markupType\": \"Paragraph\",\n \"text\": \"\\n\",\n \"type\": \"MarkupEnd\"\n },\n {\n \"altText\": null,\n \"htmlTag\": \"p\",\n \"markupType\": \"Paragraph\",\n \"text\": \"\",\n \"type\": \"MarkupBegin\",\n \"url\": null\n },\n {\n \"text\": \"Second line of text.\",\n \"type\": \"Text\"\n },\n {\n \"htmlTag\": \"p\",\n \"markupType\": \"Paragraph\",\n \"text\": \"\\n\",\n \"type\": \"MarkupEnd\"\n },\n {\n \"altText\": null,\n \"htmlTag\": \"code\",\n \"markupType\": \"Code\",\n \"text\": \"[Start code block]\\n\",\n \"type\": \"MarkupBegin\",\n \"url\": null\n },\n {\n \"text\": \"<script>\\nvar i, t = 0;\\nfor (i = 0; i < 5; i++) {\\n t += i;\\n}\\n</script>\",\n \"type\": \"Text\"\n },\n {\n \"htmlTag\": \"code\",\n \"markupType\": \"Code\",\n \"text\": \"\\n[End code block]\",\n \"type\": \"MarkupEnd\"\n },\n {\n \"accessible\": true,\n \"name\": \"Name\",\n \"record\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"text\": \"@Name\",\n \"type\": \"Mention\"\n }\n ],\n \"text\": \"Chatter Feed Item Created via API: First line of text.\\n \\nSecond line of text.\\n[Start code block]\\n<script>\\nvar i, t = 0;\\nfor (i = 0; i < 5; i++) {\\n t += i;\\n}\\n</script>\\n[End code block]@Name\"\n },\n \"capabilities\": {\n \"associatedActions\": {\n \"platformActionGroups\": []\n },\n \"bookmarks\": {\n \"isBookmarkedByCurrentUser\": false\n },\n \"chatterLikes\": {\n \"isLikedByCurrentUser\": false,\n \"likesMessage\": null,\n \"myLike\": null,\n \"page\": {\n \"currentPageToken\": 0,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"close\": {\n \"canContextUserUpdateIsClosed\": true,\n \"isClosed\": false\n },\n \"comments\": {\n \"page\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"edit\": {\n \"isEditRestricted\": false,\n \"isEditableByMeUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/edit/is-editable-by-me\",\n \"lastEditedBy\": null,\n \"lastEditedDate\": null,\n \"latestRevision\": 1,\n \"relativeLastEditedDate\": null\n },\n \"interactions\": {\n \"count\": 0\n },\n \"mute\": {\n \"isMutedByMe\": false\n },\n \"readBy\": {\n \"isReadByMe\": true,\n \"lastReadDateByMe\": \"2023-11-22T11:08:37.000Z\",\n \"page\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/read-by/items?pageSize=3\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"status\": {\n \"feedEntityStatus\": \"Published\",\n \"isApprovableByMe\": true\n },\n \"topics\": {\n \"canAssignTopics\": true,\n \"items\": []\n },\n \"upDownVote\": {\n \"downVoteCount\": 0,\n \"myVote\": \"None\",\n \"upVoteCount\": 0\n }\n },\n \"clientInfo\": {\n \"applicationName\": \"Postman Playground\",\n \"applicationUrl\": null\n },\n \"createdDate\": \"2023-11-22T11:08:37.000Z\",\n \"event\": false,\n \"feedElementType\": \"FeedItem\",\n \"hasVerifiedComment\": false,\n \"header\": {\n \"isRichText\": null,\n \"messageSegments\": [\n {\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"reference\": {\n \"id\": \"005...\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\"\n },\n \"text\": \"Name\",\n \"type\": \"EntityLink\"\n }\n ],\n \"text\": \"Name\"\n },\n \"id\": \"0D5...\",\n \"isDeleteRestricted\": false,\n \"isSharable\": false,\n \"modifiedDate\": \"2023-11-22T11:08:37.000Z\",\n \"originalFeedItem\": null,\n \"originalFeedItemActor\": null,\n \"parent\": {\n \"entityLabel\": {\n \"label\": \"Account\",\n \"labelPlural\": \"Accounts\"\n },\n \"id\": \"001...\",\n \"motif\": {\n \"color\": \"5867E8\",\n \"largeIconUrl\": \"/img/icon/accounts64.png\",\n \"mediumIconUrl\": \"/img/icon/accounts32.png\",\n \"smallIconUrl\": \"/img/icon/accounts16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Burlington Textiles Corp of America\",\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/chatter/records/001...\"\n },\n \"photoUrl\": \"https:///profilephoto/729.../T\",\n \"relativeCreatedDate\": \"Just now\",\n \"type\": \"TextPost\",\n \"url\": \"/services/data/v58.0/chatter/feed-elements/0D5...\",\n \"visibility\": \"InternalUsers\"\n}" } ] }, { "name": "Feed Elements, Batch Post", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"inputs\": [\n {\n \"richInput\": {\n \"subjectId\": \"\",\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Post Number 1\"\n }\n ]\n },\n \"capabilities\": {\n \"files\": {\n \"items\": [\n {\n \"id\": \"\"\n }\n ]\n }\n },\n \"feedElementType\": \"FeedItem\"\n }\n },\n {\n \"richInput\": {\n \"subjectId\": \"\",\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Post Number 2\"\n }\n ]\n },\n \"feedElementType\": \"FeedItem\"\n }\n },\n {\n \"richInput\": {\n \"subjectId\": \"me\",\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Post Number 3 with Inline\"\n },\n {\n \"type\": \"InlineImage\",\n \"fileId\": \"\",\n \"altText\": \"Test Inline\"\n }\n ]\n },\n \"feedElementType\": \"FeedItem\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feed-elements/batch", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feed-elements", "batch" ] }, "description": "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" }, "response": [ { "name": "Successful Feed Elements, Batch Post", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"inputs\": [\n {\n \"richInput\": {\n \"subjectId\": \"0012o00003PK8DSAA1\",\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Post Number 1\"\n }\n ]\n },\n \"feedElementType\": \"FeedItem\"\n }\n },\n {\n \"richInput\": {\n \"subjectId\": \"0052o00000DOJ1PAAX\",\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Post Number 2\"\n }\n ]\n },\n \"feedElementType\": \"FeedItem\"\n }\n },\n {\n \"richInput\": {\n \"subjectId\": \"me\",\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Post Number 3 with Inline\"\n },\n {\n \"type\": \"InlineImage\",\n \"fileId\": \"\",\n \"altText\": \"Test Inline\"\n }\n ]\n },\n \"feedElementType\": \"FeedItem\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feed-elements/batch", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feed-elements", "batch" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:11:25 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"hasErrors\": true,\n \"results\": [\n {\n \"result\": {\n \"actor\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"body\": {\n \"isRichText\": false,\n \"messageSegments\": [\n {\n \"text\": \"Post Number 1\",\n \"type\": \"Text\"\n }\n ],\n \"text\": \"Post Number 1\"\n },\n \"capabilities\": {\n \"associatedActions\": {\n \"platformActionGroups\": []\n },\n \"bookmarks\": {\n \"isBookmarkedByCurrentUser\": false\n },\n \"chatterLikes\": {\n \"isLikedByCurrentUser\": false,\n \"likesMessage\": null,\n \"myLike\": null,\n \"page\": {\n \"currentPageToken\": 0,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"close\": {\n \"canContextUserUpdateIsClosed\": true,\n \"isClosed\": false\n },\n \"comments\": {\n \"page\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"edit\": {\n \"isEditRestricted\": false,\n \"isEditableByMeUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/edit/is-editable-by-me\",\n \"lastEditedBy\": null,\n \"lastEditedDate\": null,\n \"latestRevision\": 1,\n \"relativeLastEditedDate\": null\n },\n \"interactions\": {\n \"count\": 0\n },\n \"mute\": {\n \"isMutedByMe\": false\n },\n \"readBy\": {\n \"isReadByMe\": true,\n \"lastReadDateByMe\": \"2023-11-22T11:11:25.000Z\",\n \"page\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/read-by/items?pageSize=3\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"status\": {\n \"feedEntityStatus\": \"Published\",\n \"isApprovableByMe\": true\n },\n \"topics\": {\n \"canAssignTopics\": true,\n \"items\": []\n },\n \"upDownVote\": {\n \"downVoteCount\": 0,\n \"myVote\": \"None\",\n \"upVoteCount\": 0\n }\n },\n \"clientInfo\": {\n \"applicationName\": \"Postman Playground\",\n \"applicationUrl\": null\n },\n \"createdDate\": \"2023-11-22T11:11:25.000Z\",\n \"event\": false,\n \"feedElementType\": \"FeedItem\",\n \"hasVerifiedComment\": false,\n \"header\": {\n \"isRichText\": null,\n \"messageSegments\": [\n {\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"reference\": {\n \"id\": \"005...\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\"\n },\n \"text\": \"Name\",\n \"type\": \"EntityLink\"\n }\n ],\n \"text\": \"Name\"\n },\n \"id\": \"0D5...\",\n \"isDeleteRestricted\": false,\n \"isSharable\": false,\n \"modifiedDate\": \"2023-11-22T11:11:25.000Z\",\n \"originalFeedItem\": null,\n \"originalFeedItemActor\": null,\n \"parent\": {\n \"entityLabel\": {\n \"label\": \"Account\",\n \"labelPlural\": \"Accounts\"\n },\n \"id\": \"001...\",\n \"motif\": {\n \"color\": \"5867E8\",\n \"largeIconUrl\": \"/img/icon/accounts64.png\",\n \"mediumIconUrl\": \"/img/icon/accounts32.png\",\n \"smallIconUrl\": \"/img/icon/accounts16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Burlington Textiles Corp of America\",\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/chatter/records/001...\"\n },\n \"photoUrl\": \"https:///profilephoto/729.../T\",\n \"relativeCreatedDate\": \"Just now\",\n \"type\": \"TextPost\",\n \"url\": \"/services/data/v58.0/chatter/feed-elements/0D5...\",\n \"visibility\": \"InternalUsers\"\n },\n \"statusCode\": 201\n },\n {\n \"result\": {\n \"actor\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"body\": {\n \"isRichText\": false,\n \"messageSegments\": [\n {\n \"text\": \"Post Number 2\",\n \"type\": \"Text\"\n }\n ],\n \"text\": \"Post Number 2\"\n },\n \"capabilities\": {\n \"associatedActions\": {\n \"platformActionGroups\": []\n },\n \"bookmarks\": {\n \"isBookmarkedByCurrentUser\": false\n },\n \"chatterLikes\": {\n \"isLikedByCurrentUser\": false,\n \"likesMessage\": null,\n \"myLike\": null,\n \"page\": {\n \"currentPageToken\": 0,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"close\": {\n \"canContextUserUpdateIsClosed\": true,\n \"isClosed\": false\n },\n \"comments\": {\n \"page\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/comments/items\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"edit\": {\n \"isEditRestricted\": false,\n \"isEditableByMeUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/edit/is-editable-by-me\",\n \"lastEditedBy\": null,\n \"lastEditedDate\": null,\n \"latestRevision\": 1,\n \"relativeLastEditedDate\": null\n },\n \"interactions\": {\n \"count\": 0\n },\n \"mute\": {\n \"isMutedByMe\": false\n },\n \"readBy\": {\n \"isReadByMe\": true,\n \"lastReadDateByMe\": \"2023-11-22T11:11:25.000Z\",\n \"page\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/feed-elements/0D5.../capabilities/read-by/items?pageSize=3\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n }\n },\n \"status\": {\n \"feedEntityStatus\": \"Published\",\n \"isApprovableByMe\": true\n },\n \"topics\": {\n \"canAssignTopics\": true,\n \"items\": []\n },\n \"upDownVote\": {\n \"downVoteCount\": 0,\n \"myVote\": \"None\",\n \"upVoteCount\": 0\n }\n },\n \"clientInfo\": {\n \"applicationName\": \"Postman Playground\",\n \"applicationUrl\": null\n },\n \"createdDate\": \"2023-11-22T11:11:25.000Z\",\n \"event\": false,\n \"feedElementType\": \"FeedItem\",\n \"hasVerifiedComment\": false,\n \"header\": {\n \"isRichText\": null,\n \"messageSegments\": [\n {\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"reference\": {\n \"id\": \"005...\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\"\n },\n \"text\": \"Name\",\n \"type\": \"EntityLink\"\n }\n ],\n \"text\": \"Name\"\n },\n \"id\": \"0D5...\",\n \"isDeleteRestricted\": false,\n \"isSharable\": true,\n \"modifiedDate\": \"2023-11-22T11:11:25.000Z\",\n \"originalFeedItem\": null,\n \"originalFeedItemActor\": null,\n \"parent\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"photoUrl\": \"https:///profilephoto/729.../T\",\n \"relativeCreatedDate\": \"Just now\",\n \"type\": \"TextPost\",\n \"url\": \"/services/data/v58.0/chatter/feed-elements/0D5...\",\n \"visibility\": \"AllUsers\"\n },\n \"statusCode\": 201\n },\n {\n \"result\": [\n {\n \"errorCode\": \"INVALID_MARKUP\",\n \"message\": \"Error while parsing Rich Text Content: The value of attribute "src" associated with an element type "img" must not contain the '<' character.\"\n }\n ],\n \"statusCode\": 400\n }\n ]\n}" } ] }, { "name": "Feed Element - Delete", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feed-elements/:FEED_ELEMENT_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feed-elements", ":FEED_ELEMENT_ID" ], "variable": [ { "key": "FEED_ELEMENT_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Successful Feed Element - Delete", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feed-elements/:FEED_ELEMENT_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feed-elements", ":FEED_ELEMENT_ID" ], "variable": [ { "key": "FEED_ELEMENT_ID", "value": "" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "plain", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:13:51 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Content-Security-Policy", "value": "upgrade-insecure-requests" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" } ], "cookie": [], "body": null } ] }, { "name": "Feed Elements Capability, Comments Items", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feed-elements/:FEED_ELEMENT_ID/capabilities/comments/items?text=New Comment", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feed-elements", ":FEED_ELEMENT_ID", "capabilities", "comments", "items" ], "query": [ { "key": "text", "value": "New Comment" } ], "variable": [ { "key": "FEED_ELEMENT_ID", "value": "" } ] }, "description": "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.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_feed_element_capability_comments_items.htm#connect_resources_feed_element_capability_comments_items" }, "response": [ { "name": "Feed Elements Capability, Comments Items", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/feed-elements/:FEED_ELEMENT_ID/capabilities/comments/items?text=New Comment", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "feed-elements", ":FEED_ELEMENT_ID", "capabilities", "comments", "items" ], "query": [ { "key": "text", "value": "New Comment" } ], "variable": [ { "key": "FEED_ELEMENT_ID", "value": "0D5..." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:14:33 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"body\": {\n \"isRichText\": false,\n \"messageSegments\": [\n {\n \"text\": \"New Comment\",\n \"type\": \"Text\"\n }\n ],\n \"text\": \"New Comment\"\n },\n \"capabilities\": {\n \"edit\": {\n \"isEditRestricted\": false,\n \"isEditableByMeUrl\": \"/services/data/v58.0/chatter/comments/0D7.../capabilities/edit/is-editable-by-me\",\n \"lastEditedBy\": null,\n \"lastEditedDate\": null,\n \"latestRevision\": 1,\n \"relativeLastEditedDate\": null\n },\n \"status\": {\n \"feedEntityStatus\": \"Published\",\n \"isApprovableByMe\": true\n },\n \"upDownVote\": {\n \"downVoteCount\": 0,\n \"myVote\": \"None\",\n \"upVoteCount\": 0\n },\n \"verified\": {\n \"isVerifiableByMe\": false,\n \"isVerified\": false,\n \"isVerifiedByAnonymized\": null,\n \"lastVerifiedByUser\": null,\n \"lastVerifiedDate\": null\n }\n },\n \"clientInfo\": {\n \"applicationName\": \"Postman Playground\",\n \"applicationUrl\": null\n },\n \"createdDate\": \"2023-11-22T11:14:33.000Z\",\n \"feedElement\": {\n \"id\": \"0D5...\",\n \"url\": \"/services/data/v58.0/chatter/feed-elements/0D5...\"\n },\n \"id\": \"0D7...\",\n \"isDeleteRestricted\": false,\n \"likes\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/comments/0D7.../likes\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n },\n \"likesMessage\": null,\n \"moderationFlags\": null,\n \"myLike\": null,\n \"parent\": {\n \"id\": \"001...\",\n \"url\": \"/services/data/v58.0/chatter/records/001...\"\n },\n \"relativeCreatedDate\": \"Just now\",\n \"threadLevel\": 0,\n \"threadParentId\": null,\n \"type\": \"TextComment\",\n \"url\": \"/services/data/v58.0/chatter/comments/0D7...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n}" } ] } ], "description": "Post and delete feed elements." }, { "name": "Comments", "item": [ { "name": "Comment", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {}, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Editing a comment\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/comments/:COMMENT_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "comments", ":COMMENT_ID" ], "variable": [ { "key": "COMMENT_ID", "value": "0D7..." } ] }, "description": "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" }, "response": [ { "name": "Successful Comment", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Editing a comment\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/comments/:COMMENT_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "comments", ":COMMENT_ID" ], "variable": [ { "key": "COMMENT_ID", "value": "0D72o00000E8dNiCAJ" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:20:42 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"body\": {\n \"isRichText\": true,\n \"messageSegments\": [\n {\n \"altText\": null,\n \"htmlTag\": \"p\",\n \"markupType\": \"Paragraph\",\n \"text\": \"\",\n \"type\": \"MarkupBegin\",\n \"url\": null\n },\n {\n \"text\": \"Comment\",\n \"type\": \"Text\"\n },\n {\n \"htmlTag\": \"p\",\n \"markupType\": \"Paragraph\",\n \"text\": \"\\n\",\n \"type\": \"MarkupEnd\"\n }\n ],\n \"text\": \"Comment\\n\"\n },\n \"capabilities\": {\n \"edit\": {\n \"isEditRestricted\": false,\n \"isEditableByMeUrl\": \"/services/data/v58.0/chatter/comments/0D7.../capabilities/edit/is-editable-by-me\",\n \"lastEditedBy\": null,\n \"lastEditedDate\": null,\n \"latestRevision\": 1,\n \"relativeLastEditedDate\": null\n },\n \"status\": {\n \"feedEntityStatus\": \"Published\",\n \"isApprovableByMe\": true\n },\n \"upDownVote\": {\n \"downVoteCount\": 0,\n \"myVote\": \"None\",\n \"upVoteCount\": 0\n },\n \"verified\": {\n \"isVerifiableByMe\": false,\n \"isVerified\": false,\n \"isVerifiedByAnonymized\": null,\n \"lastVerifiedByUser\": null,\n \"lastVerifiedDate\": null\n }\n },\n \"clientInfo\": null,\n \"createdDate\": \"2023-11-22T11:19:50.000Z\",\n \"feedElement\": {\n \"id\": \"0D5...\",\n \"url\": \"/services/data/v58.0/chatter/feed-elements/0D5...\"\n },\n \"id\": \"0D7...\",\n \"isDeleteRestricted\": false,\n \"likes\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/comments/0D7.../likes\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n },\n \"likesMessage\": null,\n \"moderationFlags\": null,\n \"myLike\": null,\n \"parent\": {\n \"id\": \"005...\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\"\n },\n \"relativeCreatedDate\": \"Just now\",\n \"threadLevel\": 0,\n \"threadParentId\": null,\n \"type\": \"TextComment\",\n \"url\": \"/services/data/v58.0/chatter/comments/0D7...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n}" } ] }, { "name": "Comment - Edit", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Editing a comment\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/comments/:COMMENT_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "comments", ":COMMENT_ID" ], "variable": [ { "key": "COMMENT_ID", "value": "0D7..." } ] }, "description": "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" }, "response": [ { "name": "Successful Comment - Edit", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"body\": {\n \"messageSegments\": [\n {\n \"type\": \"Text\",\n \"text\": \"Editing a comment\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/comments/:COMMENT_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "comments", ":COMMENT_ID" ], "variable": [ { "key": "COMMENT_ID", "value": "0D7..." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:22:36 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"body\": {\n \"isRichText\": false,\n \"messageSegments\": [\n {\n \"text\": \"Editing a comment\",\n \"type\": \"Text\"\n }\n ],\n \"text\": \"Editing a comment\"\n },\n \"capabilities\": {\n \"edit\": {\n \"isEditRestricted\": false,\n \"isEditableByMeUrl\": \"/services/data/v58.0/chatter/comments/0D7.../capabilities/edit/is-editable-by-me\",\n \"lastEditedBy\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"lastEditedDate\": \"2023-11-22T11:22:36.000Z\",\n \"latestRevision\": 2,\n \"relativeLastEditedDate\": \"Just now\"\n },\n \"status\": {\n \"feedEntityStatus\": \"Published\",\n \"isApprovableByMe\": true\n },\n \"upDownVote\": {\n \"downVoteCount\": 0,\n \"myVote\": \"None\",\n \"upVoteCount\": 0\n },\n \"verified\": {\n \"isVerifiableByMe\": false,\n \"isVerified\": false,\n \"isVerifiedByAnonymized\": null,\n \"lastVerifiedByUser\": null,\n \"lastVerifiedDate\": null\n }\n },\n \"clientInfo\": null,\n \"createdDate\": \"2023-11-22T11:19:50.000Z\",\n \"feedElement\": {\n \"id\": \"0D5...\",\n \"url\": \"/services/data/v58.0/chatter/feed-elements/0D5...\"\n },\n \"id\": \"0D7...\",\n \"isDeleteRestricted\": false,\n \"likes\": {\n \"currentPageToken\": null,\n \"currentPageUrl\": \"/services/data/v58.0/chatter/comments/0D7.../likes\",\n \"items\": [],\n \"nextPageToken\": null,\n \"nextPageUrl\": null,\n \"previousPageToken\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n },\n \"likesMessage\": null,\n \"moderationFlags\": null,\n \"myLike\": null,\n \"parent\": {\n \"id\": \"005...\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\"\n },\n \"relativeCreatedDate\": \"2m ago\",\n \"threadLevel\": 0,\n \"threadParentId\": null,\n \"type\": \"TextComment\",\n \"url\": \"/services/data/v58.0/chatter/comments/0D7...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n}" } ] }, { "name": "Comment - Delete", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/comments/:COMMENT_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "comments", ":COMMENT_ID" ], "variable": [ { "key": "COMMENT_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Successful Comment - Delete", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/comments/:COMMENT_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "comments", ":COMMENT_ID" ], "variable": [ { "key": "COMMENT_ID", "value": "0D7..." } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "plain", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:24:36 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Content-Security-Policy", "value": "upgrade-insecure-requests" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" } ], "cookie": [], "body": null } ] } ], "description": "Get, edit, and delete comments." }, { "name": "Groups", "item": [ { "name": "List of Groups", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups" ] }, "description": "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" }, "response": [ { "name": "Successful List of Groups", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:25:52 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"currentPageUrl\": \"/services/data/v58.0/chatter/groups\",\n \"groups\": [\n {\n \"additionalLabel\": null,\n \"announcement\": null,\n \"bannerPhoto\": {\n \"bannerPhotoUrl\": \"https:///profilephoto/0F9/B\",\n \"bannerPhotoVersionId\": null,\n \"url\": \"/services/data/v58.0/chatter/groups/0F9.../banner-photo\"\n },\n \"canHaveChatterGuests\": false,\n \"community\": null,\n \"description\": \"Test group\",\n \"emailToChatterAddress\": \"0F9...@post.2o-i6mbeaq.eu25.chatter.salesforce.com\",\n \"fileCount\": 0,\n \"id\": \"0F9...\",\n \"information\": {\n \"text\": null,\n \"title\": null\n },\n \"isArchived\": false,\n \"isAutoArchiveDisabled\": false,\n \"isBroadcast\": false,\n \"lastFeedElementPostDate\": \"2023-11-22T11:25:37.000Z\",\n \"memberCount\": 1,\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/groups64.png\",\n \"mediumIconUrl\": \"/img/icon/groups32.png\",\n \"smallIconUrl\": \"/img/icon/groups16.png\",\n \"svgIconUrl\": null\n },\n \"myRole\": \"GroupOwner\",\n \"mySubscription\": {\n \"id\": \"0FB...\",\n \"url\": \"/services/data/v58.0/chatter/group-memberships/0FB...\"\n },\n \"name\": \"Test\",\n \"owner\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Firstname\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Firstname\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/7292o000000oAgZ/T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"pendingRequests\": null,\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///img/userprofile/default_group_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/0F9/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/0F9/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https:///profilephoto/0F9/T\",\n \"standardEmailPhotoUrl\": \"https:///img/userprofile/default_group_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/chatter/groups/0F9.../photo\"\n },\n \"type\": \"CollaborationGroup\",\n \"url\": \"/services/data/v58.0/chatter/groups/0F9...\",\n \"visibility\": \"PublicAccess\"\n }\n ],\n \"nextPageUrl\": null,\n \"previousPageUrl\": null\n}" } ] }, { "name": "Group Members—Private", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups", ":GROUP_ID", "members", "requests" ], "query": [ { "key": "status", "value": "Accepted", "description": "Optional. If you include this parameter, results are filtered to include those that match the specified status. Valid values:\nAccepted\nDeclined\nPending", "disabled": true } ], "variable": [ { "key": "GROUP_ID", "value": "0F9..." } ] }, "description": "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" }, "response": [ { "name": "Successful Group Members—Private", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups", ":GROUP_ID", "members", "requests" ], "query": [ { "key": "status", "value": "Accepted", "description": "Optional. If you include this parameter, results are filtered to include those that match the specified status. Valid values:\nAccepted\nDeclined\nPending", "disabled": true } ], "variable": [ { "key": "GROUP_ID", "value": "0F9..." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:47:04 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"requests\": [\n {\n \"createdDate\": \"2023-11-22T11:46:32.000Z\",\n \"id\": \"0I5...\",\n \"lastUpdateDate\": \"2023-11-22T11:46:32.000Z\",\n \"requestedGroup\": {\n \"id\": \"0F9...\",\n \"url\": \"/services/data/v58.0/chatter/groups/0F9...\"\n },\n \"responseMessage\": null,\n \"status\": \"Pending\",\n \"url\": \"/services/data/v58.0/chatter/group-membership-requests/0I5...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1700653511864742682\",\n \"companyName\": null,\n \"displayName\": \"User Sample\",\n \"firstName\": \"User\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Sample\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"User Sample\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/005/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/005/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https:///profilephoto/005/T\",\n \"standardEmailPhotoUrl\": \"https:///img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n }\n ],\n \"total\": null\n}" } ] }, { "name": "List of Groups - POST", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups?name=New Chatter Group (Private Access)&visibility=PrivateAccess&description=Created via API&information=Private Information&isArchived=false&isAutoArchiveDisabled=false&isBroadcast=false&canHaveChatterGuests\t=true", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups" ], "query": [ { "key": "name", "value": "New Chatter Group (Private Access)" }, { "key": "visibility", "value": "PrivateAccess", "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." }, { "key": "description", "value": "Created via API" }, { "key": "information", "value": "Private Information", "description": "If the group is private, the “Information” section is visible only to members." }, { "key": "isArchived", "value": "false" }, { "key": "isAutoArchiveDisabled", "value": "false", "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." }, { "key": "isBroadcast", "value": "false", "description": "true if only group owners and managers can create posts in the group, false otherwise." }, { "key": "canHaveChatterGuests\t", "value": "true", "description": "true if this group allows Chatter customers, false otherwise. After this property is set to true, it cannot be set to false." } ] }, "description": "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" }, "response": [ { "name": "Successful List of Groups - POST", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups?name=New Chatter Group (Private Access)&visibility=PrivateAccess&description=Created via API&information=Private Information&isArchived=false&isAutoArchiveDisabled=false&isBroadcast=false&canHaveChatterGuests\t=true", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups" ], "query": [ { "key": "name", "value": "New Chatter Group (Private Access)" }, { "key": "visibility", "value": "PrivateAccess", "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." }, { "key": "description", "value": "Created via API" }, { "key": "information", "value": "Private Information", "description": "If the group is private, the “Information” section is visible only to members." }, { "key": "isArchived", "value": "false" }, { "key": "isAutoArchiveDisabled", "value": "false", "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." }, { "key": "isBroadcast", "value": "false", "description": "true if only group owners and managers can create posts in the group, false otherwise." }, { "key": "canHaveChatterGuests\t", "value": "true", "description": "true if this group allows Chatter customers, false otherwise. After this property is set to true, it cannot be set to false." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:29:04 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"additionalLabel\": \"Private With Customers\",\n \"announcement\": null,\n \"bannerPhoto\": {\n \"bannerPhotoUrl\": \"https:///profilephoto/0F9/B\",\n \"bannerPhotoVersionId\": null,\n \"url\": \"/services/data/v58.0/chatter/groups/0F9.../banner-photo\"\n },\n \"canHaveChatterGuests\": true,\n \"community\": null,\n \"description\": \"Created via API\",\n \"emailToChatterAddress\": \"0F9...@post.2o-i6mbeaq.eu25.chatter.salesforce.com\",\n \"fileCount\": 0,\n \"id\": \"0F9...\",\n \"information\": {\n \"text\": null,\n \"title\": null\n },\n \"isArchived\": false,\n \"isAutoArchiveDisabled\": false,\n \"isBroadcast\": false,\n \"lastFeedElementPostDate\": \"2023-11-22T11:29:05.000Z\",\n \"memberCount\": 1,\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/groups64.png\",\n \"mediumIconUrl\": \"/img/icon/groups32.png\",\n \"smallIconUrl\": \"/img/icon/groups16.png\",\n \"svgIconUrl\": null\n },\n \"myRole\": \"GroupOwner\",\n \"mySubscription\": {\n \"id\": \"0FB...\",\n \"url\": \"/services/data/v58.0/chatter/group-memberships/0FB...\"\n },\n \"name\": \"New Chatter Group (Private Access)\",\n \"owner\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"pendingRequests\": 0,\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///img/userprofile/default_group_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/0F9/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/0F9/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https:///profilephoto/0F9/T\",\n \"standardEmailPhotoUrl\": \"https:///img/userprofile/default_group_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/chatter/groups/0F9.../photo\"\n },\n \"type\": \"CollaborationGroup\",\n \"url\": \"/services/data/v58.0/chatter/groups/0F9...\",\n \"visibility\": \"PrivateAccess\"\n}" } ] }, { "name": "Group Invites", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"invitees\" : {\n \"emails\": [\n \"testemail1@sfdcpostman.com\",\n \"testemail2@sfdcpostman.com\"\n ]\n },\n \"message\" : \"Join this group to participate in the discussion about your favorite feature.\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/group/:GROUP_ID/invite", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups", "group", ":GROUP_ID", "invite" ], "variable": [ { "key": "GROUP_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Successful Group Invites", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"invitees\" : {\n \"emails\": [\n \"testemail1@sfdcpostman.com\",\n \"testemail2@sfdcpostman.com\"\n ]\n },\n \"message\" : \"Join this group to participate in the discussion about your favorite feature.\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/group/:GROUP_ID/invite", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups", "group", ":GROUP_ID", "invite" ], "variable": [ { "key": "GROUP_ID", "value": "0F9..." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:49:28 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"invitations\": [\n {\n \"email\": \"testemail1@sfdcpostman.com\",\n \"status\": \"Invited\",\n \"userId\": \"\"\n },\n ...\n ]\n}" } ] }, { "name": "Group Members", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups", ":GROUP_ID", "members" ], "query": [ { "key": "userId", "value": "" } ], "variable": [ { "key": "GROUP_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Successful Group Members", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members?userId=005...", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups", ":GROUP_ID", "members" ], "query": [ { "key": "userId", "value": "005..." } ], "variable": [ { "key": "GROUP_ID", "value": "0F9..." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:31:07 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"id\": \"0FB...\",\n \"lastFeedAccessDate\": null,\n \"role\": \"StandardMember\",\n \"url\": \"/services/data/v58.0/chatter/group-memberships/0FB...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"integration1.4407085834085586E12\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Integration User\",\n \"firstName\": \"Integration\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"User\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Integration User\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/005/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/005/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https:///profilephoto/005/T\",\n \"standardEmailPhotoUrl\": \"https:///img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n}" } ] }, { "name": "Group Members—Private - POST", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups", ":GROUP_ID", "members", "requests" ], "variable": [ { "key": "GROUP_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Group Members—Private - POST", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "groups", ":GROUP_ID", "members", "requests" ], "variable": [ { "key": "GROUP_ID", "value": "0F9..." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:52:41 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"createdDate\": \"2023-11-22T11:52:41.000Z\",\n \"id\": \"0I5...\",\n \"lastUpdateDate\": \"2023-11-22T11:52:41.000Z\",\n \"requestedGroup\": {\n \"id\": \"0F9...\",\n \"url\": \"/services/data/v58.0/chatter/groups/0F9...\"\n },\n \"responseMessage\": null,\n \"status\": \"Pending\",\n \"url\": \"/services/data/v58.0/chatter/group-membership-requests/0I5...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1700653511864742682\",\n \"companyName\": null,\n \"displayName\": \"User Sample\",\n \"firstName\": \"User\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Sample\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"User Sample\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/005/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/005/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https:///profilephoto/005/T\",\n \"standardEmailPhotoUrl\": \"https:///img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n}" } ] }, { "name": "Group Membership Requests—Private", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "PATCH", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/group-membership-requests/:CHATTER_GROUP_REQUEST_ID?status=Accepted&responseMessage=Welcome to the group!", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "group-membership-requests", ":CHATTER_GROUP_REQUEST_ID" ], "query": [ { "key": "status", "value": "Accepted" }, { "key": "responseMessage", "value": "Welcome to the group!" } ], "variable": [ { "key": "CHATTER_GROUP_REQUEST_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Successful Group Membership Requests—Private", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/group-membership-requests/:CHATTER_GROUP_REQUEST_ID?status=Accepted&responseMessage=Welcome to the group!", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "group-membership-requests", ":CHATTER_GROUP_REQUEST_ID" ], "query": [ { "key": "status", "value": "Accepted" }, { "key": "responseMessage", "value": "Welcome to the group!" } ], "variable": [ { "key": "CHATTER_GROUP_REQUEST_ID", "value": "0I5..." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:50:19 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"createdDate\": \"2023-11-22T11:46:32.000Z\",\n \"id\": \"0I5...\",\n \"lastUpdateDate\": \"2023-11-22T11:50:19.000Z\",\n \"requestedGroup\": {\n \"id\": \"0F9...\",\n \"url\": \"/services/data/v58.0/chatter/groups/0F9...\"\n },\n \"responseMessage\": null,\n \"status\": \"Accepted\",\n \"url\": \"/services/data/v58.0/chatter/group-membership-requests/0I5...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1700653511864742682\",\n \"companyName\": null,\n \"displayName\": \"User Sample\",\n \"firstName\": \"User\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Sample\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"User Sample\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/005/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/005/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https:///profilephoto/005/T\",\n \"standardEmailPhotoUrl\": \"https:///img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n}" } ] } ], "description": "Get groups and group members. Create groups, invites, and members." }, { "name": "User", "item": [ { "name": "User Photo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "disabled": true }, { "key": "Content-Disposition", "value": "form-data; name=\"photo\"", "disabled": true }, { "key": "Content-Type", "value": "application/json; charset=UTF-8", "disabled": true } ], "body": { "mode": "formdata", "formdata": [ { "key": "json", "value": "{\"cropY\":\"0\",\"cropX\":\"0\",\"cropSize\":\"200\"}", "type": "text" }, { "key": "fileUpload", "type": "file", "value": null } ] }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/user-profiles/me/photo", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "user-profiles", "me", "photo" ] }, "description": "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 feed, cache the user photos. Then use the photoVersionId property of the Photo response body to determine when you need to update a photo. This technique helps you avoid running over limits and may improve mobile client performance." }, "response": [ { "name": "Succesful User Photo", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "disabled": true }, { "key": "Content-Disposition", "value": "form-data; name=\"photo\"", "disabled": true }, { "key": "Content-Type", "value": "application/json; charset=UTF-8", "disabled": true } ], "body": { "mode": "formdata", "formdata": [ { "key": "json", "value": "{\"cropY\":\"0\",\"cropX\":\"0\",\"cropSize\":\"200\"}", "type": "text" }, { "key": "fileUpload", "type": "file", "src": "/Users/scolladon/Downloads/1x1.png" } ] }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/user-profiles/me/photo", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "user-profiles", "me", "photo" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:15:44 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"fullEmailPhotoUrl\": \"https:///img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n}" } ] }, { "name": "User Messages, General", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/users/me/messages?text=This is a private message&recipients=,", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "users", "me", "messages" ], "query": [ { "key": "text", "value": "This is a private message" }, { "key": "inReplyTo", "value": "", "description": "ID of an existing message that identifies which conversation this message is part of. Specify either recipients or inReplyTo. Specify one or the other, not both.", "disabled": true }, { "key": "recipients", "value": ",", "description": "Comma-separated list of User IDs" } ] }, "description": "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" }, "response": [ { "name": "Successful User Messages, General", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/users/me/messages?text=This is a private message&recipients=0052o00000DKQasAAH", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "users", "me", "messages" ], "query": [ { "key": "text", "value": "This is a private message" }, { "key": "inReplyTo", "value": "", "description": "ID of an existing message that identifies which conversation this message is part of. Specify either recipients or inReplyTo. Specify one or the other, not both.", "disabled": true }, { "key": "recipients", "value": "0052o00000DKQasAAH", "description": "Comma-separated list of User IDs" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:22:22 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"body\": {\n \"isRichText\": null,\n \"messageSegments\": [],\n \"text\": \"This is a private message\"\n },\n \"conversationId\": \"03M...\",\n \"conversationUrl\": \"/services/data/v58.0/chatter/users/me/conversations/03M...\",\n \"id\": \"03J...\",\n \"recipients\": [\n {\n \"additionalLabel\": null,\n \"communityNickname\": \"automatedprocess\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Automated Process\",\n \"firstName\": \"Automated\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Process\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Automated Process\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/005/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/005/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https:///profilephoto/005/T\",\n \"standardEmailPhotoUrl\": \"https:///img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"System\"\n },\n {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"FirstName\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n ],\n \"sender\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Name\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Name\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/729.../F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/729.../M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https:///profilephoto/729.../T\",\n \"standardEmailPhotoUrl\": \"https:///ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"sendingCommunity\": null,\n \"sentDate\": \"\",\n \"url\": \"/services/data/v58.0/chatter/users/me/messages/03J...\"\n}" } ] }, { "name": "Following", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/users/:USER_ID/following", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "users", ":USER_ID", "following" ], "query": [ { "key": "filterType", "value": "", "description": "Specifies the key prefix to filter the type of objects returned. The key prefix is the three-character prefix code in the object ID. Object IDs are prefixed with three-character codes that specify the type of the object. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number to return. The default value is 0, which returns the first page.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the number of items per page. Valid values are between 1 and 1000. If you don't specify a size, the default is 25.\n", "disabled": true } ], "variable": [ { "key": "USER_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Successful Following", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/users/:USER_ID/following", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "users", ":USER_ID", "following" ], "query": [ { "key": "filterType", "value": "", "description": "Specifies the key prefix to filter the type of objects returned. The key prefix is the three-character prefix code in the object ID. Object IDs are prefixed with three-character codes that specify the type of the object. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.", "disabled": true }, { "key": "page", "value": "", "description": "Specifies the page number to return. The default value is 0, which returns the first page.", "disabled": true }, { "key": "pageSize", "value": "", "description": "Specifies the number of items per page. Valid values are between 1 and 1000. If you don't specify a size, the default is 25.\n", "disabled": true } ], "variable": [ { "key": "USER_ID", "value": "0052o00000DKQasAAH" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:25:01 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"currentPageUrl\": \"/services/data/v58.0/chatter/users/0052o00000DKQasAAH/following\",\n \"following\": [],\n \"nextPageUrl\": null,\n \"previousPageUrl\": null,\n \"total\": 0\n}" } ] }, { "name": "Following - POST", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/users/:USER_ID/following?subjectId=", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "users", ":USER_ID", "following" ], "query": [ { "key": "subjectId", "value": "" } ], "variable": [ { "key": "USER_ID", "value": "" } ] }, "description": "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" }, "response": [ { "name": "Successful Following - POST", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/users/:USER_ID/following?subjectId=0012o00003O9lADAAZ", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "users", ":USER_ID", "following" ], "query": [ { "key": "subjectId", "value": "0012o00003O9lADAAZ" } ], "variable": [ { "key": "USER_ID", "value": "0052o00000DKQarAAH" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 20 Nov 2023 16:27:09 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"community\": null,\n \"id\": \"0E8...\",\n \"subject\": {\n \"entityLabel\": {\n \"label\": \"Account\",\n \"labelPlural\": \"Accounts\"\n },\n \"id\": \"001...\",\n \"motif\": {\n \"color\": \"5867E8\",\n \"largeIconUrl\": \"/img/icon/accounts64.png\",\n \"mediumIconUrl\": \"/img/icon/accounts32.png\",\n \"smallIconUrl\": \"/img/icon/accounts16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Exemple de comptes pour les autorisations\",\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/chatter/records/001...\"\n },\n \"subscriber\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"integration1.4407085834085586E12\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Integration User\",\n \"firstName\": \"Integration\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"User\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"Integration User\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https:///img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https:///profilephoto/005/F\",\n \"mediumPhotoUrl\": \"https:///profilephoto/005/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https:///profilephoto/005/T\",\n \"standardEmailPhotoUrl\": \"https:///img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n },\n \"url\": \"/services/data/v58.0/chatter/subscriptions/0E8...\"\n}" } ] } ], "description": "Create user photos and user messages. Get user subscription information.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Delete Subscription", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/subscriptions/:SUBSCRIPTION_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "subscriptions", ":SUBSCRIPTION_ID" ], "variable": [ { "key": "SUBSCRIPTION_ID", "value": "0E8..." } ] }, "description": "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.htm" }, "response": [ { "name": "Delete Subscription", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/chatter/subscriptions/:SUBSCRIPTION_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "chatter", "subscriptions", ":SUBSCRIPTION_ID" ], "variable": [ { "key": "SUBSCRIPTION_ID", "value": "0E8..." } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "plain", "header": [ { "key": "Date", "value": "Wed, 22 Nov 2023 11:34:47 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Content-Security-Policy", "value": "upgrade-insecure-requests" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" } ], "cookie": [], "body": null } ] } ], "description": "Get feeds, post and delete feed elements. Get, update, and delete comments. Get groups and group members. Create groups, invites, and members. Create user photos and user messages. Get user subscription information. Delete a subscription." }, { "name": "Industries", "item": [ { "name": "Business Rules Engine", "item": [ { "name": "expression-set", "item": [ { "name": "version", "item": [ { "name": "Retrieve expression set version dependencies", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/version/:expressionSetVersionId/dependencies", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", "version", ":expressionSetVersionId", "dependencies" ], "variable": [ { "key": "expressionSetVersionId", "value": "9QMHo000000LBnbOAG", "description": "Expression Set Version Id: For Example 9QLHo000000LBjEOAW" } ] }, "description": "[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\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v58.0/connect/business-rules/expression-set/version/9QARN000000016v4AA/dependencies\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[Expression Set Version Dependency](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_version_dependency_output.htm)" }, "response": [ { "name": "Status500-UnexpectedError", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/version/:expressionSetVersionId/dependencies", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", "version", ":expressionSetVersionId", "dependencies" ], "variable": [ { "key": "expressionSetVersionId", "value": "9QMHo000000LBjOOAW" } ] } }, "status": "Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 14:26:46 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INTERNAL_ERROR\",\n \"message\": \"Unexpected Error\"\n }\n]" }, { "name": "Status400-BadRequest", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/version/:expressionSetVersionId/dependencies", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", "version", ":expressionSetVersionId", "dependencies" ], "variable": [ { "key": "expressionSetVersionId", "value": "9QLHo000000LBjJOAW" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 14:28:18 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_ID_FIELD\",\n \"message\": \"Invalid identifier: 9QLHo000000LBjJOAW\"\n }\n]" }, { "name": "Status404-RecordNotFound", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/version/:expressionSetVersionId/dependencies", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", "version", ":expressionSetVersionId", "dependencies" ], "variable": [ { "key": "expressionSetVersionId", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 14:29:34 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist\"\n }\n]" } ] } ] }, { "name": "Expression Set Creation", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"apiName\": \"myExpressionSet2\",\n \"contextDefinitions\": [],\n \"name\": \"myExpressionSet3\",\n \"usageType\": \"Bre\",\n \"versions\": [\n {\n \"apiName\": \"myExpressionSet_V1\",\n \"enabled\": false,\n \"id\": \"9QMHo000000LBjOOAW\",\n \"name\": \"myExpressionSet V1\",\n \"showExplExternally\": false,\n \"startDate\": \"2023-09-06T10:35:11.000Z\",\n \"steps\": [],\n \"variables\": [],\n \"versionNumber\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set" ] }, "description": "[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 constants.Resource\n\n```\n/connect/business-rules/expression-set\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect\n/business-rules/expression-set\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nRequest body for POST\n\nRoot XML tag\n\nJSON example\n\n```\n{\n \"name\": \"CTX Mapping ES\",\n \"apiName\": \"CTX_Mapping_ES_1\",\n \"description\": \"...\",\n \"usageType\": \"Bre\",\n \"contextDefinitions\": [\n {\n \"id\": \"11Oxx0000006PcLEAU\"\n }\n ],\n \"versions\": [\n {\n \"name\": \"CTX_Mapping_ES_1 V1\",\n \"apiName\": \"CTX_Mapping_ES_1_V1\",\n \"description\": \"Sample CTX Mapping\",\n \"startDate\": \"2022-11-14T20:31:47.000+0000\",\n \"endDate\": \"2022-11-14T20:31:47.000+0000\",\n \"versionNumber\": 1,\n \"rank\": 1,\n \"enabled\": true,\n \"showExplExternally\": false,\n \"steps\": [\n {\n \"name\": \"Condition1\",\n \"description\": \"Condition step for conditions w.r.t product\",\n \"sequenceNumber\": 1,\n \"resultIncluded\": true,\n \"stepType\": \"Condition\",\n \"conditionExpression\": {\n \"expression\": \"productName == 'iPhone' && productColor == 'Red'\",\n \"resultParameter\": \"condition_output__1\"\n }\n }\n ],\n \"variables\": [\n {\n \"name\": \"productName\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productName\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"productColor\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productColor\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"condition_output__1\",\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__1\",\n \"input\": false,\n \"output\": true,\n \"resultStep\": \"Condition1\",\n \"type\": \"Variable\"\n }\n ]\n }\n ]\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| apiName | String | Unique name of the expression set. | Required | 58.0 |\n| context​Definitions | [Context Definition Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_context_definition_input.htm) | List of context definitions in an expression set. | Optional | 58.0 |\n| description | String | Description of the expression set. | Optional | 58.0 |\n| name | String | Name of the expression set. | Required | 58.0 |\n| usage​Type | String | Usage type of the expression set.

Valid values are:

- AiAccelerator​SubscriberChurn​Prediction—Used for Industries Einstein

- Bre—Used for Business Rules Engine

- CustomLoyalty—Used for Loyalty Management

- DefaultPricing—Used for Pricing Plans in Enterprise Product Catalog (EPC) by Communications Cloud

- Qualification—Used for Industries Communications, Media, and Energy (CME)

- RecordAlert—Used for Financial Services Cloud

- ShipAndDebit—Used for Manufacturing Cloud

- TierProcessing—Used for Loyalty Management

- TransactionJournal—Used for Loyalty Management

- WarrantyClaim—Used for Manufacturing Cloud | Required | 58.0 |\n| versions | [Expression Set Version Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_expression_set_version.htm)\\[\\] | List of the expression set versions. | Optional | 58.0 |\n\nResponse body for POST\n\n[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_output.htm)" }, "response": [ { "name": "Status500-ErrorNoBody", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set" ] } }, "status": "Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:21:45 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"message\": \"An unexpected error occurred. Please include this ErrorId if you contact support: 675649159-184801 (-177293139)\",\n \"errorCode\": \"UNKNOWN_EXCEPTION\"\n }\n]" }, { "name": "Status400-MissingMandatoryBodyFields", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:31:10 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_INPUT\",\n \"message\": \"Specify a value for name parameter and try again.\"\n }\n]" }, { "name": "Status400-InvalidEnum", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"apiName\": \"myExpressionSet\",\n \"name\": \"myExpressionSet\",\n \"usageType\": \"myExpressionSet\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:34:18 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"POST_BODY_PARSE_ERROR\",\n \"message\": \"Invalid value for Expression Set Usage Type enum values: myExpressionSet\"\n }\n]" }, { "name": "Status201-SuccessCreatedOnlyMandatoryFields", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"apiName\": \"myExpressionSet\",\n \"name\": \"myExpressionSet\",\n \"usageType\": \"Bre\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:35:10 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"apiName\": \"myExpressionSet\",\n \"contextDefinitions\": [],\n \"id\": \"9QLHo000000LBjJOAW\",\n \"name\": \"myExpressionSet\",\n \"usageType\": \"Bre\",\n \"versions\": [\n {\n \"apiName\": \"myExpressionSet_V1\",\n \"enabled\": false,\n \"id\": \"9QMHo000000LBjOOAW\",\n \"name\": \"myExpressionSet V1\",\n \"showExplExternally\": false,\n \"startDate\": \"2023-09-06T10:35:11.000Z\",\n \"steps\": [],\n \"variables\": [],\n \"versionNumber\": 1\n }\n ]\n}" }, { "name": "Status400-Duplicate", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"apiName\": \"myExpressionSet\",\n \"contextDefinitions\": [],\n \"name\": \"myExpressionSet\",\n \"usageType\": \"Bre\",\n \"versions\": [\n {\n \"apiName\": \"myExpressionSet_V1\",\n \"enabled\": false,\n \"id\": \"9QMHo000000LBjOOAW\",\n \"name\": \"myExpressionSet V1\",\n \"showExplExternally\": false,\n \"startDate\": \"2023-09-06T10:35:11.000Z\",\n \"steps\": [],\n \"variables\": [],\n \"versionNumber\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 11:02:51 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_INPUT\",\n \"message\": \"An expression set with the API name myExpressionSet exists. Specify a unique apiName for the expression set and try again.\"\n }\n]" } ] }, { "name": "Expression Set Retrieve", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBngOAG", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] }, "description": "# 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\": \"CTX_Mapping_ES_1\",\n \"description\": \"...\",\n \"usageType\": \"Bre\",\n \"contextDefinitions\": [\n {\n \"id\": \"11Oxx0000006PcLEAU\"\n }\n ],\n \"versions\": [\n {\n \"name\": \"CTX_Mapping_ES_1 V1\",\n \"apiName\": \"CTX_Mapping_ES_1_V1\",\n \"description\": \"Sample CTX Mapping\",\n \"startDate\": \"2022-11-14T20:31:47.000+0000\",\n \"endDate\": \"2022-11-14T20:31:47.000+0000\",\n \"versionNumber\": 1,\n \"rank\": 1,\n \"enabled\": true,\n \"showExplExternally\": false,\n \"steps\": [\n {\n \"name\": \"Condition1\",\n \"description\": \"Condition step for conditions w.r.t product\",\n \"sequenceNumber\": 1,\n \"resultIncluded\": true,\n \"stepType\": \"Condition\",\n \"conditionExpression\": {\n \"expression\": \"productName == 'iPhone' && productColor == 'Red'\",\n \"resultParameter\": \"condition_output__1\"\n }\n }\n ],\n \"variables\": [\n {\n \"name\": \"productName\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productName\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"productColor\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productColor\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"condition_output__1\",\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__1\",\n \"input\": false,\n \"output\": true,\n \"resultStep\": \"Condition1\",\n \"type\": \"Variable\"\n }\n ]\n }\n ]\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| apiName | String | Unique name of the expression set. | Required | 58.0 |\n| context​Definitions | [Context Definition Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_context_definition_input.htm) | List of context definitions in an expression set. | Optional | 58.0 |\n| description | String | Description of the expression set. | Optional | 58.0 |\n| name | String | Name of the expression set. | Required | 58.0 |\n| usage​Type | String | Usage type of the expression set.

Valid values are:

\\- AiAccelerator​SubscriberChurn​Prediction—Used for Industries Einstein

\\- Bre—Used for Business Rules Engine

\\- CustomLoyalty—Used for Loyalty Management

\\- DefaultPricing—Used for Pricing Plans in Enterprise Product Catalog (EPC) by Communications Cloud

\\- Qualification—Used for Industries Communications, Media, and Energy (CME)

\\- RecordAlert—Used for Financial Services Cloud

\\- ShipAndDebit—Used for Manufacturing Cloud

\\- TierProcessing—Used for Loyalty Management

\\- TransactionJournal—Used for Loyalty Management

\\- WarrantyClaim—Used for Manufacturing Cloud | Required | 58.0 |\n| versions | [Expression Set Version Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_expression_set_version.htm)\\[\\] | List of the expression set versions. | Optional | 58.0 |\n\nResponse body for GET[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_output.htm)" }, "response": [ { "name": "Status200-RecordFound", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjEOAW", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 09:34:42 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"apiName\": \"myExpressionSet\",\n \"contextDefinitions\": [],\n \"id\": \"9QLHo000000LBjEOAW\",\n \"name\": \"myExpressionSet\",\n \"usageType\": \"Bre\",\n \"versions\": [\n {\n \"apiName\": \"myExpressionSet_V1\",\n \"description\": \"myExpressionSet V1 Description\",\n \"enabled\": true,\n \"id\": \"9QMHo000000LBjJOAW\",\n \"name\": \"myExpressionSet V1\",\n \"rank\": 1,\n \"showExplExternally\": true,\n \"startDate\": \"2023-09-06T09:27:06.000Z\",\n \"steps\": [\n {\n \"actionType\": \"AssignParameterValues\",\n \"assignment\": {\n \"assignedParameter\": \"condition_output__1\",\n \"expression\": \"true\"\n },\n \"description\": \"my Description\",\n \"name\": \"myCalculation\",\n \"resultIncluded\": true,\n \"sequenceNumber\": 1,\n \"shouldExposeConditionDetails\": false,\n \"shouldExposeExecPathMsgOnly\": true,\n \"shouldShowExplExternally\": false,\n \"stepType\": \"BusinessKnowledgeModel\"\n }\n ],\n \"variables\": [\n {\n \"collection\": false,\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__1\",\n \"input\": false,\n \"name\": \"condition_output__1\",\n \"output\": true,\n \"type\": \"Variable\",\n \"value\": \"False\"\n },\n {\n \"collection\": false,\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__2\",\n \"input\": false,\n \"name\": \"condition_output__2\",\n \"output\": false,\n \"type\": \"Variable\",\n \"value\": \"False\"\n }\n ],\n \"versionNumber\": 1\n }\n ]\n}" }, { "name": "Status404-RecordNotFound", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjEOA", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 09:56:59 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist\"\n }\n]" }, { "name": "Status400-PreviouslyDeletedRecord", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjEOAW", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:29:39 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_INPUT\",\n \"message\": \"The expression set id is not available.\"\n }\n]" }, { "name": "Status400-InvalidIdentifierOfVersion", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QMHo000000LBjOOAW", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:37:51 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_ID_FIELD\",\n \"message\": \"Invalid identifier: 9QMHo000000LBjOOAW\"\n }\n]" } ] }, { "name": "Expression Set Update", "request": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"apiName\": \"myExpressionSet\",\n \"contextDefinitions\": [],\n \"name\": \"myExpressionSet2\",\n \"usageType\": \"Bre\",\n \"versions\": [\n {\n \"apiName\": \"myExpressionSet_V1\",\n \"enabled\": false,\n \"id\": \"9QMHo000000LBjOOAW\",\n \"name\": \"myExpressionSet V1\",\n \"showExplExternally\": false,\n \"startDate\": \"2023-09-06T10:35:11.000Z\",\n \"steps\": [],\n \"variables\": [],\n \"versionNumber\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjJOAW", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] }, "description": "# 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_reference.meta/industries_reference/connect_responses_expression_set_output.htm)\n\nRequest body for PATCH\n\nRoot XML tag\n\nJSON example\n\n```\n{\n \"name\": \"CTX Mapping ES\",\n \"apiName\": \"CTX_Mapping_ES_1\",\n \"description\": \"...\",\n \"usageType\": \"Bre\",\n \"contextDefinitions\": [\n {\n \"id\": \"11Oxx0000006PcLEAU\"\n }\n ],\n \"versions\": [\n {\n \"name\": \"CTX_Mapping_ES_1 V1\",\n \"apiName\": \"CTX_Mapping_ES_1_V1\",\n \"description\": \"Sample CTX Mapping\",\n \"startDate\": \"2022-11-14T20:31:47.000+0000\",\n \"endDate\": \"2022-11-14T20:31:47.000+0000\",\n \"versionNumber\": 1,\n \"rank\": 1,\n \"enabled\": true,\n \"showExplExternally\": false,\n \"steps\": [\n {\n \"name\": \"Condition1\",\n \"description\": \"Condition step for conditions w.r.t product\",\n \"sequenceNumber\": 1,\n \"resultIncluded\": true,\n \"stepType\": \"Condition\",\n \"conditionExpression\": {\n \"expression\": \"productName == 'iPhone' && productColor == 'Red'\",\n \"resultParameter\": \"condition_output__1\"\n }\n }\n ],\n \"variables\": [\n {\n \"name\": \"productName\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productName\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"productColor\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productColor\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"condition_output__1\",\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__1\",\n \"input\": false,\n \"output\": true,\n \"resultStep\": \"Condition1\",\n \"type\": \"Variable\"\n }\n ]\n }\n ]\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| apiName | String | Unique name of the expression set. | Required | 58.0 |\n| context​Definitions | [Context Definition Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_context_definition_input.htm) | List of context definitions in an expression set. | Optional | 58.0 |\n| description | String | Description of the expression set. | Optional | 58.0 |\n| name | String | Name of the expression set. | Required | 58.0 |\n| usage​Type | String | Usage type of the expression set.

Valid values are:

- AiAccelerator​SubscriberChurn​Prediction—Used for Industries Einstein

- Bre—Used for Business Rules Engine

- CustomLoyalty—Used for Loyalty Management

- DefaultPricing—Used for Pricing Plans in Enterprise Product Catalog (EPC) by Communications Cloud

- Qualification—Used for Industries Communications, Media, and Energy (CME)

- RecordAlert—Used for Financial Services Cloud

- ShipAndDebit—Used for Manufacturing Cloud

- TierProcessing—Used for Loyalty Management

- TransactionJournal—Used for Loyalty Management

- WarrantyClaim—Used for Manufacturing Cloud | Required | 58.0 |\n| versions | [Expression Set Version Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_expression_set_version.htm)\\[\\] | List of the expression set versions. | Optional | 58.0 |\n\nResponse body for PATCH\n\n[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_output.htm)" }, "response": [ { "name": "Status500-ErrorNoBody", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjJOAW", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:43:16 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"message\": \"An unexpected error occurred. Please include this ErrorId if you contact support: 1895340064-166877 (-1526419893)\",\n \"errorCode\": \"UNKNOWN_EXCEPTION\"\n }\n]" }, { "name": "Status400-UnrecognizedBodyField", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"apiName\": \"myExpressionSet\",\n \"contextDefinitions\": [],\n \"id\": \"9QLHo000000LBjJOAW\",\n \"name\": \"myExpressionSet\",\n \"usageType\": \"Bre\",\n \"versions\": [\n {\n \"apiName\": \"myExpressionSet_V1\",\n \"enabled\": false,\n \"id\": \"9QMHo000000LBjOOAW\",\n \"name\": \"myExpressionSet V1\",\n \"showExplExternally\": false,\n \"startDate\": \"2023-09-06T10:35:11.000Z\",\n \"steps\": [],\n \"variables\": [],\n \"versionNumber\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjJOAW", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:44:53 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"JSON_PARSER_ERROR\",\n \"message\": \"Unrecognized field \\\"id\\\" at [line:4, column:12]\"\n }\n]" }, { "name": "Status404-RecordNotFound", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"apiName\": \"myExpressionSet\",\n \"contextDefinitions\": [],\n \"id\": \"9QLHo000000LBjJOAW\",\n \"name\": \"myExpressionSet\",\n \"usageType\": \"Bre\",\n \"versions\": [\n {\n \"apiName\": \"myExpressionSet_V1\",\n \"enabled\": false,\n \"id\": \"9QMHo000000LBjOOAW\",\n \"name\": \"myExpressionSet V1\",\n \"showExplExternally\": false,\n \"startDate\": \"2023-09-06T10:35:11.000Z\",\n \"steps\": [],\n \"variables\": [],\n \"versionNumber\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjJOA", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:46:00 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist\"\n }\n]" }, { "name": "Status400-ErrorInvalidInput", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"apiName\": \"myExpressionSet2\",\n \"contextDefinitions\": [],\n \"name\": \"myExpressionSet\",\n \"usageType\": \"Bre\",\n \"versions\": [\n {\n \"apiName\": \"myExpressionSet_V1\",\n \"enabled\": false,\n \"id\": \"9QMHo000000LBjOOAW\",\n \"name\": \"myExpressionSet V1\",\n \"showExplExternally\": false,\n \"startDate\": \"2023-09-06T10:35:11.000Z\",\n \"steps\": [],\n \"variables\": [],\n \"versionNumber\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjJOAW", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:47:31 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_INPUT\",\n \"message\": \"You can’t modify the apiName of an expression set.\"\n }\n]" }, { "name": "Status200-SuccessfullyUpdated", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"apiName\": \"myExpressionSet\",\n \"contextDefinitions\": [],\n \"name\": \"myExpressionSet2\",\n \"usageType\": \"Bre\",\n \"versions\": [\n {\n \"apiName\": \"myExpressionSet_V1\",\n \"enabled\": false,\n \"id\": \"9QMHo000000LBjOOAW\",\n \"name\": \"myExpressionSet V1\",\n \"showExplExternally\": false,\n \"startDate\": \"2023-09-06T10:35:11.000Z\",\n \"steps\": [],\n \"variables\": [],\n \"versionNumber\": 1\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjJOAW", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:48:19 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"apiName\": \"myExpressionSet\",\n \"contextDefinitions\": [],\n \"id\": \"9QLHo000000LBjJOAW\",\n \"name\": \"myExpressionSet2\",\n \"usageType\": \"Bre\",\n \"versions\": [\n {\n \"apiName\": \"myExpressionSet_V1\",\n \"enabled\": false,\n \"id\": \"9QMHo000000LBjOOAW\",\n \"name\": \"myExpressionSet V1\",\n \"showExplExternally\": false,\n \"startDate\": \"2023-09-06T10:35:11.000Z\",\n \"steps\": [],\n \"variables\": [],\n \"versionNumber\": 1\n }\n ]\n}" } ] }, { "name": "Expression Set Delete", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjEOA", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] }, "description": "# 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\": \"CTX_Mapping_ES_1\",\n \"description\": \"...\",\n \"usageType\": \"Bre\",\n \"contextDefinitions\": [\n {\n \"id\": \"11Oxx0000006PcLEAU\"\n }\n ],\n \"versions\": [\n {\n \"name\": \"CTX_Mapping_ES_1 V1\",\n \"apiName\": \"CTX_Mapping_ES_1_V1\",\n \"description\": \"Sample CTX Mapping\",\n \"startDate\": \"2022-11-14T20:31:47.000+0000\",\n \"endDate\": \"2022-11-14T20:31:47.000+0000\",\n \"versionNumber\": 1,\n \"rank\": 1,\n \"enabled\": true,\n \"showExplExternally\": false,\n \"steps\": [\n {\n \"name\": \"Condition1\",\n \"description\": \"Condition step for conditions w.r.t product\",\n \"sequenceNumber\": 1,\n \"resultIncluded\": true,\n \"stepType\": \"Condition\",\n \"conditionExpression\": {\n \"expression\": \"productName == 'iPhone' && productColor == 'Red'\",\n \"resultParameter\": \"condition_output__1\"\n }\n }\n ],\n \"variables\": [\n {\n \"name\": \"productName\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productName\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"productColor\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productColor\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"condition_output__1\",\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__1\",\n \"input\": false,\n \"output\": true,\n \"resultStep\": \"Condition1\",\n \"type\": \"Variable\"\n }\n ]\n }\n ]\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| apiName | String | Unique name of the expression set. | Required | 58.0 |\n| context​Definitions | [Context Definition Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_context_definition_input.htm) | List of context definitions in an expression set. | Optional | 58.0 |\n| description | String | Description of the expression set. | Optional | 58.0 |\n| name | String | Name of the expression set. | Required | 58.0 |\n| usage​Type | String | Usage type of the expression set.

Valid values are:

\\- AiAccelerator​SubscriberChurn​Prediction—Used for Industries Einstein

\\- Bre—Used for Business Rules Engine

\\- CustomLoyalty—Used for Loyalty Management

\\- DefaultPricing—Used for Pricing Plans in Enterprise Product Catalog (EPC) by Communications Cloud

\\- Qualification—Used for Industries Communications, Media, and Energy (CME)

\\- RecordAlert—Used for Financial Services Cloud

\\- ShipAndDebit—Used for Manufacturing Cloud

\\- TierProcessing—Used for Loyalty Management

\\- TransactionJournal—Used for Loyalty Management

\\- WarrantyClaim—Used for Manufacturing Cloud | Required | 58.0 |\n| versions | [Expression Set Version Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_expression_set_version.htm)\\[\\] | List of the expression set versions. | Optional | 58.0 |\n\nResponse body for GET\n\n[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_output.htm)" }, "response": [ { "name": "Status404-RecordNotFound", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjEOA", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 09:56:59 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist\"\n }\n]" }, { "name": "Status400-ActiveExpressionCanNotBeDeleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjEOAW", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:23:24 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_INPUT\",\n \"message\": \"An enabled Expression Set Version cannot be updated/deleted.\"\n }\n]" }, { "name": "Status204-SuccessDeleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjEOAW", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "plain", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:27:12 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Content-Security-Policy", "value": "upgrade-insecure-requests" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" } ], "cookie": [], "body": null }, { "name": "Status400-TryToDeletePreviouslyDeleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expression-set/:expressionSetId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expression-set", ":expressionSetId" ], "variable": [ { "key": "expressionSetId", "value": "9QLHo000000LBjEOAW", "description": "Expression Set Id: For Example 9QLHo000000LBjEOAW" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 10:28:24 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_INPUT\",\n \"message\": \"The expression set id is not available.\"\n }\n]" } ] } ], "description": "[SALESFORCE > HELP DOCS > INDUSTRIES COMMON FEATURES GUIDE > Expression Sets](https://help.salesforce.com/s/articleView?id=sf.expression_sets.htm)\n\n[SALESFORCE > HELP DOCS > INDUSTRIES COMMON FEATURES GUIDE > Expression Sets for Developers](https://help.salesforce.com/s/articleView?id=sf.expression_sets_for_developers.htm)\n\n\"\"" }, { "name": "expressionset", "item": [ { "name": "Expression Set Invocation", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"inputs\": [{}],\n \"options\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expressionset/:expressionSetAPIName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expressionset", ":expressionSetAPIName" ], "variable": [ { "key": "expressionSetAPIName", "value": "", "description": "The API name of an expression set is unique within your Salesforce instance." } ] }, "description": "[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```\n/connect/business-rules/expressionSet/${expressionSetName}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/vXX.X/connect\n/business-rules/expressionSet/${expressionSetName}\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 1\n\n```\n{\n \"inputs\": [\n {\n \"age\": \"25\",\n \"state\": \"CA\"\n \"PatientId\":\"001xx000003GYjnAAG\"\n }\n \n ],\n \"options\": {\n \"effectiveDate\": \"2022-12-03T10:15:30Z\",\n \"useDatesOnly\": \"true\"\n }\n}\n\n ```\n\nJSON example 2\n\n```\n{\n \"inputs\": [\n {\n \"age\": \"25\",\n \"state\": \"CA\"\n \"PatientId\":\"001xx000003GYjnAAG\"\n \"__actionContextCode\":\"001xx000003GYjnAAG\" }\n \n ],\n \"options\": {\n \"effectiveDate\": \"2022-12-03T10:15:30Z\",\n \"useDatesOnly\": \"true\"\n }\n}\n\n ```\n\nNote\n\nYou can use more than one actionContextCode for multiple sets of inputs, passed in a single API call.\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| inputs | Map\\[\\] | List of inputs passed to an expression set. An input may contain multiple variables.

Note

If the expression set uses a field alias as a variable, append Id to the object alias to which the field alias belongs, and pass the ID of the source object linked to the object alias. | Required | 55.0 |\n| options | [Expression Set Options Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_options.htm) | The options for executing an expression set. | Optional | 55.0 |\n\nResponse body for POST\n\n[Business Rules Result](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_business_rules_result.htm)" }, "response": [ { "name": "Status500-EmptyBodyButRecordExists", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expressionset/:expressionSetAPIName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expressionset", ":expressionSetAPIName" ], "variable": [ { "key": "expressionSetAPIName", "value": "myExpressionSet", "description": "The API name of an expression set is unique within your Salesforce instance." } ] } }, "status": "Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 07 Sep 2023 07:48:43 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"message\": \"An unexpected error occurred. Please include this ErrorId if you contact support: 597330588-4312 (-1669188241)\",\n \"errorCode\": \"UNKNOWN_EXCEPTION\"\n }\n]" }, { "name": "Status400-InvalidExpressionSetName", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"inputs\": [{}],\n \"options\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expressionset/:expressionSetAPIName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expressionset", ":expressionSetAPIName" ], "variable": [ { "key": "expressionSetAPIName", "value": "blah blah", "description": "The API name of an expression set is unique within your Salesforce instance." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 07 Sep 2023 08:03:38 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_INPUT\",\n \"message\": \"Specify a valid expressionSetName and try again.\"\n }\n]" }, { "name": "Status201-Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"inputs\": [{}],\n \"options\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/expressionset/:expressionSetAPIName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "expressionset", ":expressionSetAPIName" ], "variable": [ { "key": "expressionSetAPIName", "value": "myExpressionSet", "description": "The API name of an expression set is unique within your Salesforce instance." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 07 Sep 2023 08:05:45 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"aggregationResults\": {\n \"results\": {}\n },\n \"executionId\": \"33045b23-8970-4fbe-a80c-8f4302592566\",\n \"outputs\": [\n {\n \"results\": {\n \"output\": 1\n }\n }\n ]\n}" } ] } ], "description": "**WATCH OUT**: expressionSet has no dash compared to the other expression set resources. Elected to create separate Postman folder to model this odity. [gjeffcock@salesforce.com](https://gjeffcock@salesforce.com)" }, { "name": "decision-matrices", "item": [ { "name": "Lookup Table", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"inputs\": [\n {\n \"input\": [\n {\n \"name\": \"myColumnInput\",\n \"value\": \"One\"\n }\n ]\n }\n ],\n \"options\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-matrices", ":matrixUniqueName" ], "variable": [ { "key": "matrixUniqueName", "value": "myDecisionMatrix", "description": "The value of Unique Name is the unique identifier of the record, which is sourced from the name of a decision matrix." } ] }, "description": "# 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 \"input\": [\n {\n \"name\": \"premium\",\n \"value\": \"2400\"\n }\n ]\n }\n ],\n \"options\": {\n \"effectiveDate\": \"2022-12-03T10:15:30Z\"\n }\n}\n\n ```\n\nHere, premium is a column header in the matrix, and 2400 is a value of a cell in the column.Properties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| inputs | [Decision Matrix Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_matrix_input.htm) | List of inputs passed to a decision matrix. An input may contain multiple variables. | Required | 55.0 |\n| options | [Decision Matrix Options Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_matrix_options.htm) | The lookup options for a decision matrix. | Optional | 55.0 |\n\nResponse body for POST\n\n[Decision Matrix Lookup Result](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_bre_decision_matrix_lookup_result.htm)" }, "response": [ { "name": "Status401-Unauthorized", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-matrices", ":matrixUniqueName" ], "variable": [ { "key": "matrixUniqueName", "value": "blah", "description": "Matrix Unique Name" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 07 Sep 2023 11:49:04 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "WWW-Authenticate", "value": "Token" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"message\": \"Session expired or invalid\",\n \"errorCode\": \"INVALID_SESSION_ID\"\n }\n]" }, { "name": "Status400-MatrixNotFound", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-matrices", ":matrixUniqueName" ], "variable": [ { "key": "matrixUniqueName", "value": "blah", "description": "Matrix Unique Name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 07 Sep 2023 11:50:19 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_INPUT\",\n \"message\": \"Specify a valid matrixName and try again.\"\n }\n]" }, { "name": "Status400-UnknownException", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"inputs\": [{}],\n \"options\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixAPIName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-matrices", ":matrixAPIName" ], "variable": [ { "key": "matrixAPIName", "value": "myDecisionMatrix", "description": "Matrix API Name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 07 Sep 2023 12:10:47 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"UNKNOWN_EXCEPTION\",\n \"message\": \"Something went wrong. Try again or ask your Salesforce admin for help.\"\n }\n]" }, { "name": "Status201-AcceptedButWarning", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"inputs\": [\n {\n \"input\": [\n {\n \"name\": \"myColumnInput\",\n \"value\": \"One\"\n }\n ]\n }\n ],\n \"options\": {\n \"effectiveDate\": \"2022-12-03T10:15:30Z\"\n }\n}\n", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixAPIName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-matrices", ":matrixAPIName" ], "variable": [ { "key": "matrixAPIName", "value": "myDecisionMatrix", "description": "Matrix API Name" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 07 Sep 2023 12:12:26 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"outputs\": [\n {\n \"error\": \"Looks like there isn’t any output for the specified input parameters in the lookup table.\",\n \"results\": []\n }\n ]\n}" }, { "name": "Status201-Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"inputs\": [\n {\n \"input\": [\n {\n \"name\": \"myColumnInput\",\n \"value\": \"One\"\n }\n ]\n }\n ],\n \"options\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixAPIName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-matrices", ":matrixAPIName" ], "variable": [ { "key": "matrixAPIName", "value": "myDecisionMatrix", "description": "Matrix API Name" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 07 Sep 2023 12:15:06 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"outputs\": [\n {\n \"results\": [\n {\n \"name\": \"myColumnOutput\",\n \"value\": \"1\"\n }\n ]\n }\n ]\n}" }, { "name": "Status201-Success", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-matrices", ":matrixUniqueName" ], "variable": [ { "key": "matrixUniqueName", "value": "myDecisionMatrix", "description": "Matrix Unique Name" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 07 Sep 2023 12:02:02 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"outputs\": []\n}" }, { "name": "Status201-KeyPairNotFound", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"inputs\": [\n {\n \"input\": [\n {\n \"name\": \"myColumnInput\",\n \"value\": \"Two\"\n }\n ]\n }\n ],\n \"options\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-matrices/:matrixUniqueName", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-matrices", ":matrixUniqueName" ], "variable": [ { "key": "matrixUniqueName", "value": "myDecisionMatrix", "description": "Matrix Unique Name" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 07 Sep 2023 12:28:57 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"outputs\": [\n {\n \"error\": \"Looks like there isn’t any output for the specified input parameters in the lookup table.\",\n \"results\": []\n }\n ]\n}" } ] } ], "description": "# [Decision Matrices for Developers](https://help.salesforce.com/s/articleView?id=sf.decision_matrices_for_developers.htm)\n\nDevelopers in your Salesforce org can employ decision matrix developer resources to use and extend decision matrices.\n\n### REQUIRED EDITIONS\n\n| Available in: Lightning Experience |\n| Available in: **Enterprise**, **Unlimited**, and **Developer** Editions for Industries clouds that have Business Rules Engine enabled |\n\n## Connect REST API\n\n- [Look up decision matrices](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_resources_bre_decision_matrix.htm)\n \n- [Export decision matrix versions to DMN files](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_resources_bre_decision_model_entity.htm)\n \n\n## Metadata API\n\n- [Create decision matrices](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/meta_decisionmatrixdefinition.htm)\n \n\n## Invocable Actions\n\n- [Invoke a decision matrix in a flow using the decision matrix action](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/actions_obj_decision_matrix.htm)" }, { "name": "decision-models", "item": [ { "name": "Decision Model Notation Export", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"decisionModelEntityIds\": [\n \"0lNHo000000LEvfMAG\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-models/export", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-models", "export" ] }, "description": "# 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/decision-models/export\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 \"decisionModelEntityIds\":[\n “0lNRO00000004f72AA”,\n “0lNRO000000rfn27AA”\n ]\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| decisionModelEntityIds | String\\[\\] | A list of decision matrix version IDs to export data from. | Required | 58.0 |\n\nResponse body for POST\n\n[Decision Model Export Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_model_export_output.htm)\n\n# Decision Model Export Output\n\nOutput representation of a completed DMN (Decision Model Notation) export request.JSON example\n\n```\n{\n \"message\":\"OK\",\n \"success\":true,\n \"errors\":[\n {\n \"errorCode\":\"BAD_REQUEST\",\n \"errorMessage\":\"We couldn’t find this record. Specify a valid ID for decisionModelEntityIds parameter.\",\n \"recordId\":\"0lNRO00000004fsdfAA\"\n }\n ]\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| errors | [Decision Model Export Error](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_model_export_error.htm)\\[\\] | List of errors corresponding to a failed export request. | Small, 58.0 | 58.0 |\n| message | String | Response message from the completed export request. | Small, 58.0 | 58.0 |\n| success | Boolean | Indicates whether the export request was successful (true) or not (false). | Small, 58.0 | 58.0 |" }, "response": [ { "name": "Status201-BadRequest", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"decisionModelEntityIds\": [\n \"0lNRO00000004f72AA\",\n \"0lNRO000000rfn27AA\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-models/export", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-models", "export" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 12:01:33 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"errorCode\": \"BAD_REQUEST\",\n \"errorMessage\": \"We couldn’t find this record. Specify a valid ID for decisionModelEntityIds parameter.\",\n \"recordId\": \"0lNRO00000004f72AA\"\n },\n {\n \"errorCode\": \"BAD_REQUEST\",\n \"errorMessage\": \"We couldn’t find this record. Specify a valid ID for decisionModelEntityIds parameter.\",\n \"recordId\": \"0lNRO000000rfn27AA\"\n }\n ],\n \"message\": \"OK\",\n \"success\": true\n}" }, { "name": "Status500-EmptyBody", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-models/export", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-models", "export" ] } }, "status": "Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 12:02:44 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"message\": \"An unexpected error occurred. Please include this ErrorId if you contact support: 1291449758-100210 (-239130079)\",\n \"errorCode\": \"UNKNOWN_EXCEPTION\"\n }\n]" }, { "name": "Status201-Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"decisionModelEntityIds\": [\n \"0lNHo000000LEvfMAG\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-models/export", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-models", "export" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 12:07:06 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"OK\",\n \"success\": true\n}" } ] } ] }, { "name": "decision-table", "item": [ { "name": "lookup", "item": [ { "name": "Invoke", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"datasetLinkName\": \"transactionMapping\",\n \"conditions\": [\n {\n \"conditionsList\": [\n {\n \"fieldName\": \"Product__c\",\n \"value\": \"Nike\",\n \"operator\": \"Matches\" //Operator is optional\n },\n {\n \"fieldName\": \"Price__c\",\n \"value\": 1000,\n \"operator\": \"GreaterThan\"\n }\n ]\n },\n {\n \"conditionsList\": [\n {\n \"fieldName\": \"Product__c\",\n \"value\": \"Adidas\",\n \"operator\": \"Matches\" //Operator is optional\n },\n {\n \"fieldName\": \"Price__c\",\n \"value\": 1500,\n \"operator\": \"GreaterThan\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/lookup/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "lookup", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Po3", "description": "Decision Table Id" } ] }, "description": "# 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\" : \"transactionMapping\",\n “conditions” :[\n {\n “conditionsList”: [\n {\n \"fieldName\": \"Product__c\",\n \"value\": \"Nike\",\n \"operator\": \"Matches\" //Operator is optional\n },\n {\n \"fieldName\": \"Price__c\",\n \"value\": 1000,\n \"operator\": \"GreaterThan\"\n }\n ]\n },\n {\n “conditionsList”: [\n {\n \"fieldName\": \"Product__c\",\n \"value\": \"Adidas\",\n \"operator\": \"Matches\" //Operator is optional\n },\n {\n \"fieldName\": \"Price__c\",\n \"value\": 1500,\n \"operator\": \"GreaterThan\"\n }\n ]\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| conditions | [Decision Table Condition List](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_table_condition_list_input.htm) | The list of decision table conditions on which the decision table executes and provides outcomes. | Required | 58.0 |\n| datasetLinkName | String | The API name of the dataset link provided as an input for the decision table execution. | Optional | 58.0 |\n\nResponse body for POST\n\n[Decision Table Bulk Outcome](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_bulk_outcome.htm)\n\n# Decision Table Bulk Outcome\n\nOutput representation of the decision table bulk look-up.\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| outputs | [Decision Table Outcome](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_outcome.htm) | List of the output of the Decision Table bulk lookup. | Small, 58.0 | 58.0 |" }, "response": [ { "name": "Status404-NotFound", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"datasetLinkName\": \"transactionMapping\",\n \"conditions\": [\n {\n \"conditionsList\": [\n {\n \"fieldName\": \"Product__c\",\n \"value\": \"Nike\",\n \"operator\": \"Matches\" //Operator is optional\n },\n {\n \"fieldName\": \"Price__c\",\n \"value\": 1000,\n \"operator\": \"GreaterThan\"\n }\n ]\n },\n {\n \"conditionsList\": [\n {\n \"fieldName\": \"Product__c\",\n \"value\": \"Adidas\",\n \"operator\": \"Matches\" //Operator is optional\n },\n {\n \"fieldName\": \"Price__c\",\n \"value\": 1500,\n \"operator\": \"GreaterThan\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/lookup/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "lookup", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Pnt", "description": "Decision Table Id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 14:11:45 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist\"\n }\n]" }, { "name": "Status400-InvalidOperation", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"datasetLinkName\": \"transactionMapping\",\n \"conditions\": [\n {\n \"conditionsList\": [\n {\n \"fieldName\": \"Product__c\",\n \"value\": \"Nike\",\n \"operator\": \"Matches\" //Operator is optional\n },\n {\n \"fieldName\": \"Price__c\",\n \"value\": 1000,\n \"operator\": \"GreaterThan\"\n }\n ]\n },\n {\n \"conditionsList\": [\n {\n \"fieldName\": \"Product__c\",\n \"value\": \"Adidas\",\n \"operator\": \"Matches\" //Operator is optional\n },\n {\n \"fieldName\": \"Price__c\",\n \"value\": 1500,\n \"operator\": \"GreaterThan\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/lookup/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "lookup", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Po3", "description": "Decision Table Id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 14:16:11 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_OPERATION\",\n \"message\": \"Can't execute decision table which is not in Active state.\"\n }\n]" }, { "name": "Status201-Error", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"datasetLinkName\": \"transactionMapping\",\n \"conditions\": [\n {\n \"conditionsList\": [\n {\n \"fieldName\": \"Product__c\",\n \"value\": \"Nike\",\n \"operator\": \"Matches\" //Operator is optional\n },\n {\n \"fieldName\": \"Price__c\",\n \"value\": 1000,\n \"operator\": \"GreaterThan\"\n }\n ]\n },\n {\n \"conditionsList\": [\n {\n \"fieldName\": \"Product__c\",\n \"value\": \"Adidas\",\n \"operator\": \"Matches\" //Operator is optional\n },\n {\n \"fieldName\": \"Price__c\",\n \"value\": 1500,\n \"operator\": \"GreaterThan\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/lookup/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "lookup", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Po3", "description": "Decision Table Id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 14:17:24 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"outputs\": [\n {\n \"errorCode\": 400,\n \"errorMessage\": \"Specify valid name for Data set Link\",\n \"outcomeList\": [],\n \"outcomeType\": null,\n \"successStatus\": false\n },\n {\n \"errorCode\": 400,\n \"errorMessage\": \"Specify valid name for Data set Link\",\n \"outcomeList\": [],\n \"outcomeType\": null,\n \"successStatus\": false\n }\n ]\n}" } ] } ] }, { "name": "Create Table", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"setupName\":\"Product Qualificiation eligibility\",\n \"fullName\":\"ProductQualificationEligibility\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "definitions" ] }, "description": "# 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\":\"Product Qualificiation eligibility\",\n \"fullName\":\"ProductQualificationEligibility\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"usageType\":\"ProductEligibility\",\n \"sourceType\":\"SingleSobject\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"collectOperator\":\"Count\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\"\n }\n ]\n}\n\n ```\n\nJSON example for a multi-object source\n\n```\n{\n \"setupName\":\"Jumbo Pricing Definition\",\n \"fullName\":\"JumboPricingDefinition\",\n \"description\":\"Join all the DT definitions into one jumbo pricing definition\",\n \"usageType\":\"ProductEligibility\",\n \"type\":\"LowVolume\",\n \"sourceType\":\"MultipleSobjects\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"collectOperator\":\"Count\",\n \"sourceconditionLogic\":\"1 AND 2 AND 3\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3 OR 4 OR 5\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\",\n \"columnMapping\":\"IsDeleted\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\",\n \"columnMapping\":\"Id\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\",\n \"columnMapping\":\"Title\"\n },\n {\n \"fieldName\":\"OldvalNumber\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"4\",\n \"columnMapping\":\"AccountHistory.OldvalNumber\"\n },\n {\n \"fieldName\":\"OldvalString\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"5\",\n \"columnMapping\":\"AccountHistory.OldvalString\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\",\n \"columnMapping\":\"CreatedById\"\n },\n {\n \"fieldName\":\"NewvalNumber\",\n \"usage\":\"OUTPUT\",\n \"columnMapping\":\"AccountHistory.NewvalNumber\"\n },\n {\n \"fieldName\":\"NewvalString\",\n \"usage\":\"OUTPUT\",\n \"columnMapping\":\"AccountHistory.NewvalString\"\n }\n ]\n \"sourceCriteria\":[\n {\n \"sourceFieldName\":\"OldvalString\",\n \"value\":\"5\",\n \"operator\":\"Equals\",\n \"valueType\":\"Parameter\",\n \"sequenceNumber\":\"1\"\n }\n ]\n}\n\n ```\n\nRequest body for POSTProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| collectOperator | String | Operator to apply a filter to outputs. Possible values are:

\\- Count

\\- Maximum

\\- Minimum

\\- None

\\- Sum | Optional | 58.0 |\n| conditionCriteria | String | Custom logic applied on the decision table columns to decide how the input fields are processed. | Optional

Required when the condition type is Custom. | 58.0 |\n| conditionType | String | Condition logic for input fields. Possible values are:

\\- All

\\- Any

\\- Custom | Optional | 58.0 |\n| description | String | Description of the decision table. | Optional | 58.0 |\n| decisionResultPolicy | String | Results policy to filter results of the decision table. Possible values are:

\\- AnyValue

\\- CollectOperator

\\- FirstMatch

\\- OutputOrder

\\- Priority

\\- RuleOrder

\\- UniqueValues | Optional | |\n| fullName | String | Unique name of the rule definition. | Required | 58.0 |\n| isSetCollectOperator | Boolean | For internal use only.

Indicates whether the collectOperator is enabled (true) or not (false). | Optional | 58.0 |\n| isSetConditionCriteria | Boolean | For internal use only.

Indicates whether the conditionCriteria field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetConditionType | Boolean | For internal use only.

Indicates whether the conditionType field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetDescription | Boolean | For internal use only.

Indicates whether the description field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetDecisionResultPolicy | Boolean | For internal use only.

Indicates whether the DecisionResultPolicy field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetFullName | Boolean | For internal use only.

Indicates whether the FullName field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetParameters | Boolean | For internal use only. Indicates whether the parameters field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetSetupName | Boolean | For internal use only.

Indicates whether the setupName field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetSourceconditionLogic | Boolean | For internal use only.

Indicates whether the sourceConditionLogic field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetSourceCriteria | Boolean | For internal use only.

Indicates whether the sourceCriteria field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetSourceObject | Boolean | For internal use only.

Indicates whether the sourceObject field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetSourceType | Boolean | For internal use only.

Indicates whether the sourceType is enabled (true) or not (false). | Optional | 58.0 |\n| isSetType | Boolean | For internal use only.

Indicates whether the type field is enabled (true) or not (false). | Optional | 58.0 |\n| isSetUsageType | Boolean | For internal use only.

Indicates whether the UsageType field is enabled (true) or not (false). | Optional | 58.0 |\n| parameters | [Decision Table Parameter Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_table_parameter_input.htm)\\[\\] | Array of input and output fields for the decision table. | Optional | 58.0 |\n| setupName | String | Name of the decision table. | Required | 58.0 |\n| sourceconditionLogic | String | Custom logic to filter the decision table rows. | Optional | 58.0 |\n| sourceCriteria | [Decision Table Source Criteria Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_table_source_criteria_input.htm)\\[\\] | Output array representation of source filters for the decision table rows, such as, fieldName, operators, valueType, and more. | Optional | 58.0 |\n| sourceObject | String | Object containing business rules for the decision table to read. | Required | 58.0 |\n| sourceType | String | Type of source to obtain decision table data. Possible values are:

\\- CsvUpload

\\- MultipleSobjects

\\- SingleSobject | Required | 58.0 |\n| status | String | Status of the decision table. Possible values are:

\\- ActivationInProgress

\\- ActivationInProgress

\\- Draft

\\- Inactive | Required | 58.0 |\n| type | String | Type of the decision table. Possible values are:

\\- HighVolume

\\- LowVolume | Optional | 58.0 |\n| usageType | String | Process type that uses the decision table. Possible values are:

\\- Pricing

\\- ProductEligibility | Optional | 58.0 |\n\nResponse body for POST\n\n[Decision Table Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_output.htm)\n\n# Decision Table Output\n\nOutput representation of the decision table details.JSON example for GET, POST, and PATCH\n\n```\n{\n \"code\":\"200\",\n \"decisionTable\":{\n \"collectOperator\":\"Count\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"conditionType\":\"Any\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"id\":\"0lDxx00000000BJ\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":1,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"usage\":\"Output\"\n },\n {\n \"fieldName\":\"Title\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":3,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"Id\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":2,\n \"usage\":\"Input\"\n }\n ],\n \"setupName\":\"Product Qualificiation eligibility3\",\n \"sourceCriteria\":[\n \n ],\n \"sourceObject\":\"AccountFeed\",\n \"sourceType\":\"SingleSobject\",\n \"sourceconditionLogic\":\"1 AND 2 AND 3\",\n \"status\":\"Draft\"\n },\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\nJSON example for DELETE\n\n```\n{\n \"code\":\"200\",\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| code | String | Response code from the API request. | Small, 58.0 | 58.0 |\n| decisionTable | [Decision Table Definition Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_definition_output.htm) | Details of the decision table definition associated with the decision table. | Small, 58.0 | 58.0 |\n| isSuccess | Boolean | Indicates whether the API request is successful (true) or not (false). | Small, 58.0 | 58.0 |\n| message | String | Error message when the API request fails. | Small, 58.0 | 58.0 |" }, "response": [ { "name": "Status201-Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"setupName\":\"Product Qualificiation eligibility\",\n \"fullName\":\"ProductQualificationEligibility\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "definitions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 12:41:36 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"code\": \"200\",\n \"decisionTable\": {\n \"id\": \"0lDHo0000008Pnt\",\n \"parameters\": [],\n \"sourceCriteria\": []\n },\n \"isSuccess\": true,\n \"message\": \"\"\n}" } ] }, { "name": "Get Table", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "{\n \"setupName\":\"Product Qualificiation eligibility\",\n \"fullName\":\"ProductQualificationEligibility\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "definitions", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Po3", "description": "Decision Table Id" } ] }, "description": "# 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_reference.meta/industries_reference/connect_responses_decision_table_output.htm)\n\n# Decision Table Output\n\nOutput representation of the decision table details.JSON example for GET, POST, and PATCH\n\n```\n{\n \"code\":\"200\",\n \"decisionTable\":{\n \"collectOperator\":\"Count\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"conditionType\":\"Any\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"id\":\"0lDxx00000000BJ\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":1,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"usage\":\"Output\"\n },\n {\n \"fieldName\":\"Title\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":3,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"Id\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":2,\n \"usage\":\"Input\"\n }\n ],\n \"setupName\":\"Product Qualificiation eligibility3\",\n \"sourceCriteria\":[\n \n ],\n \"sourceObject\":\"AccountFeed\",\n \"sourceType\":\"SingleSobject\",\n \"sourceconditionLogic\":\"1 AND 2 AND 3\",\n \"status\":\"Draft\"\n },\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\nJSON example for DELETE\n\n```\n{\n \"code\":\"200\",\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| code | String | Response code from the API request. | Small, 58.0 | 58.0 |\n| decisionTable | [Decision Table Definition Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_definition_output.htm) | Details of the decision table definition associated with the decision table. | Small, 58.0 | 58.0 |\n| isSuccess | Boolean | Indicates whether the API request is successful (true) or not (false). | Small, 58.0 | 58.0 |\n| message | String | Error message when the API request fails. | Small, 58.0 | 58.0 |" }, "response": [ { "name": "Status200-Success", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "{\n \"setupName\":\"Product Qualificiation eligibility\",\n \"fullName\":\"ProductQualificationEligibility\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "definitions", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Pnt", "description": "Decision Table Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 13:05:06 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"code\": \"200\",\n \"decisionTable\": {\n \"conditionCriteria\": \"1 OR 2 OR 3\",\n \"conditionType\": \"Any\",\n \"description\": \"Eligiblity of Products using Qualification Rules\",\n \"id\": \"0lDHo0000008Pnt\",\n \"parameters\": [\n {\n \"fieldName\": \"IsDeleted\",\n \"isGroupByField\": false,\n \"operator\": \"Equals\",\n \"sequence\": 1,\n \"usage\": \"Input\"\n },\n {\n \"fieldName\": \"CreatedById\",\n \"isGroupByField\": false,\n \"usage\": \"Output\"\n },\n {\n \"fieldName\": \"Title\",\n \"isGroupByField\": false,\n \"operator\": \"Equals\",\n \"sequence\": 3,\n \"usage\": \"Input\"\n },\n {\n \"fieldName\": \"Id\",\n \"isGroupByField\": false,\n \"operator\": \"Equals\",\n \"sequence\": 2,\n \"usage\": \"Input\"\n }\n ],\n \"setupName\": \"Product Qualificiation eligibility\",\n \"sourceCriteria\": [],\n \"sourceObject\": \"AccountFeed\",\n \"status\": \"Active\"\n },\n \"isSuccess\": true,\n \"message\": \"\"\n}" }, { "name": "Status400-InstanceNotFound", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "{\n \"setupName\":\"Product Qualificiation eligibility\",\n \"fullName\":\"ProductQualificationEligibility\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "definitions", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Pnn", "description": "Decision Table Id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 13:20:33 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_ID_FIELD\",\n \"message\": \"We couldn’t find a record with that ID. Specify a valid decisionTableId and try again.\"\n }\n]" }, { "name": "Status200-Success", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "{\n \"setupName\":\"Product Qualificiation eligibility\",\n \"fullName\":\"ProductQualificationEligibility\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "definitions", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Po3", "description": "Decision Table Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 14:13:01 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"code\": \"200\",\n \"decisionTable\": {\n \"conditionCriteria\": \"1 OR 2 OR 3\",\n \"conditionType\": \"Any\",\n \"description\": \"Eligiblity of Products using Qualification Rules\",\n \"id\": \"0lDHo0000008Po3\",\n \"parameters\": [\n {\n \"fieldName\": \"IsDeleted\",\n \"isGroupByField\": false,\n \"operator\": \"Equals\",\n \"sequence\": 1,\n \"usage\": \"Input\"\n },\n {\n \"fieldName\": \"CreatedById\",\n \"isGroupByField\": false,\n \"usage\": \"Output\"\n },\n {\n \"fieldName\": \"Title\",\n \"isGroupByField\": false,\n \"operator\": \"Equals\",\n \"sequence\": 3,\n \"usage\": \"Input\"\n },\n {\n \"fieldName\": \"Id\",\n \"isGroupByField\": false,\n \"operator\": \"Equals\",\n \"sequence\": 2,\n \"usage\": \"Input\"\n }\n ],\n \"setupName\": \"Product Qualificiation eligibility\",\n \"sourceCriteria\": [],\n \"sourceObject\": \"AccountFeed\",\n \"status\": \"Draft\"\n },\n \"isSuccess\": true,\n \"message\": \"\"\n}" } ] }, { "name": "Delete Table", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "definitions", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Pny", "description": "Decision Table Id" } ] }, "description": "# 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.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_output.htm)\n\n# Decision Table Output\n\nOutput representation of the decision table details.JSON example for GET, POST, and PATCH\n\n```\n{\n \"code\":\"200\",\n \"decisionTable\":{\n \"collectOperator\":\"Count\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"conditionType\":\"Any\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"id\":\"0lDxx00000000BJ\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":1,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"usage\":\"Output\"\n },\n {\n \"fieldName\":\"Title\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":3,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"Id\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":2,\n \"usage\":\"Input\"\n }\n ],\n \"setupName\":\"Product Qualificiation eligibility3\",\n \"sourceCriteria\":[\n \n ],\n \"sourceObject\":\"AccountFeed\",\n \"sourceType\":\"SingleSobject\",\n \"sourceconditionLogic\":\"1 AND 2 AND 3\",\n \"status\":\"Draft\"\n },\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\nJSON example for DELETE\n\n```\n{\n \"code\":\"200\",\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| code | String | Response code from the API request. | Small, 58.0 | 58.0 |\n| decisionTable | [Decision Table Definition Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_definition_output.htm) | Details of the decision table definition associated with the decision table. | Small, 58.0 | 58.0 |\n| isSuccess | Boolean | Indicates whether the API request is successful (true) or not (false). | Small, 58.0 | 58.0 |\n| message | String | Error message when the API request fails. | Small, 58.0 | 58.0 |" }, "response": [ { "name": "Status204-SuccessDeleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "definitions", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Pnt", "description": "Decision Table Id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "plain", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 13:36:22 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "Content-Security-Policy", "value": "upgrade-insecure-requests" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" } ], "cookie": [], "body": null } ] }, { "name": "Update Table", "request": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"setupName\":\"Product Qualificiation eligibility\",\n \"fullName\":\"ProductQualificationEligibility\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"usageType\":\"ProductEligibility\",\n \"sourceType\":\"SingleSobject\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"collectOperator\":\"Count\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "definitions", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Po3", "description": "Decision Table Id" } ] }, "description": "# 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.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_output.htm)\n\n# Decision Table Output\n\nOutput representation of the decision table details.JSON example for GET, POST, and PATCH\n\n```\n{\n \"code\":\"200\",\n \"decisionTable\":{\n \"collectOperator\":\"Count\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"conditionType\":\"Any\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"id\":\"0lDxx00000000BJ\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":1,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"usage\":\"Output\"\n },\n {\n \"fieldName\":\"Title\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":3,\n \"usage\":\"Input\"\n },\n {\n \"fieldName\":\"Id\",\n \"isGroupByField\":false,\n \"isPriority\":false,\n \"operator\":\"Equals\",\n \"sequence\":2,\n \"usage\":\"Input\"\n }\n ],\n \"setupName\":\"Product Qualificiation eligibility3\",\n \"sourceCriteria\":[\n \n ],\n \"sourceObject\":\"AccountFeed\",\n \"sourceType\":\"SingleSobject\",\n \"sourceconditionLogic\":\"1 AND 2 AND 3\",\n \"status\":\"Draft\"\n },\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\nJSON example for DELETE\n\n```\n{\n \"code\":\"200\",\n \"isSuccess\":true,\n \"message\":\"\"\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| code | String | Response code from the API request. | Small, 58.0 | 58.0 |\n| decisionTable | [Decision Table Definition Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_definition_output.htm) | Details of the decision table definition associated with the decision table. | Small, 58.0 | 58.0 |\n| isSuccess | Boolean | Indicates whether the API request is successful (true) or not (false). | Small, 58.0 | 58.0 |\n| message | String | Error message when the API request fails. | Small, 58.0 | 58.0 |" }, "response": [ { "name": "Status200-Success", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"setupName\":\"Product Qualificiation eligibility\",\n \"fullName\":\"ProductQualificationEligibility\",\n \"description\":\"Eligiblity of Products using Qualification Rules\",\n \"usageType\":\"ProductEligibility\",\n \"sourceType\":\"SingleSobject\",\n \"sourceObject\":\"AccountFeed\",\n \"status\":\"Draft\",\n \"decisionResultPolicy\":\"UniqueValues\",\n \"collectOperator\":\"Count\",\n \"conditionType\":\"Any\",\n \"conditionCriteria\":\"1 OR 2 OR 3\",\n \"parameters\":[\n {\n \"fieldName\":\"IsDeleted\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"1\"\n },\n {\n \"fieldName\":\"Id\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"2\"\n },\n {\n \"fieldName\":\"Title\",\n \"usage\":\"INPUT\",\n \"operator\":\"Equals\",\n \"sequence\":\"3\"\n },\n {\n \"fieldName\":\"CreatedById\",\n \"usage\":\"OUTPUT\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/definitions/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", "definitions", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Po3", "description": "Decision Table Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 14:02:00 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"code\": \"200\",\n \"isSuccess\": true,\n \"message\": \"\"\n}" } ] }, { "name": "Lookup Table", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"conditions\": {\n \"conditionsList\": [\n {\n \"fieldName\": \"IsDeleted\",\n \"value\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Pnt", "description": "Decision Table Id" } ] }, "description": "# 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 \"value\": \"MH\"\n },\n {\n \"fieldName\": \"validity__c\",\n \"value\": 30\n }\n ]\n }\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| conditions | [Decision Table Condition](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_decision_table_condition.htm)\\[\\] | The list of decision table conditions on which the decision table executes and provides outcomes. | Required | 55.0 |\n| datasetLinkName | String | The API name of the dataset link provided as an input for the decision table execution. | Optional | 55.0 |\n\nResponse body for POST\n\n[Decision Table Outcome](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_outcome.htm)\n\n# Decision Table Outcome\n\nOutput representation of the decision table execution.JSON example\n\n```\n{\n \"errorCode\" : null,\n \"errorMessage\" : null,\n \"outcomeList\" : [ {\n \"values\" : {\n \"amount__c\" : \"399\",\n \"Name\" : \"MH 005\"\n }\n }, {\n \"values\" : {\n \"amount__c\" : \"499\",\n \"Name\" : \"MH 006\"\n }\n }, {\n \"values\" : {\n \"amount__c\" : \"379\",\n \"Name\" : \"MH 007\"\n }\n }, {\n \"values\" : {\n \"amount__c\" : \"1498\",\n \"Name\" : \"MH 008\"\n }\n }, {\n \"values\" : {\n \"amount__c\" : \"98\",\n \"Name\" : \"MH 009\"\n }\n }, {\n \"values\" : {\n \"amount__c\" : \"251\",\n \"Name\" : \"MH 010\"\n }\n } ],\n \"outcomeType\" : \"Multiple Matches\",\n \"successStatus\" : true\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| errorCode | Integer | The error code if transaction fails for any reason. | Small, 55.0 | 55.0 |\n| errorMessage | String | The error message if transaction fails for any reason. | Small, 55.0 | 55.0 |\n| outcomeList | [Decision Table Outcome Item](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_table_outcome_item.htm)\\[\\] | Outcome list that stores two or more outcomes provided by the decision table. | Small, 55.0 | 55.0 |\n| outcomeType | String | The outcome type after the request is successful. | Small, 55.0 | 55.0 |\n| successStatus | Boolean | Indicates the status of the decision table execution. | Small, 55.0 | 55.0 |" }, "response": [ { "name": "Status400-BadRequest", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"conditions\": {\n \"conditionsList\": [\n {\n \"fieldName\": \"state__c\",\n \"value\": \"MH\"\n },\n {\n \"fieldName\": \"validity__c\",\n \"value\": 30\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lIHo000000LFC6MAO", "description": "Decision Table Id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 12:16:33 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"INVALID_ID_FIELD\",\n \"message\": \"Invalid identifier: 0lIHo000000LFC6MAO\"\n }\n]" }, { "name": "Status500-UnknownException", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"conditions\": {\n \"conditionsList\": [\n {\n \"fieldName\": \"Comment Count\",\n \"value\": 1\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008PnjMAE", "description": "Decision Table Id" } ] } }, "status": "Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 12:31:01 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"message\": \"An unexpected error occurred. Please include this ErrorId if you contact support: 1716762391-743375 (1633993601)\",\n \"errorCode\": \"UNKNOWN_EXCEPTION\"\n }\n]" }, { "name": "Status201-Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"conditions\": {\n \"conditionsList\": [\n {\n \"fieldName\": \"IsDeleted\",\n \"value\": true\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/decision-table/:decisionTableId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "decision-table", ":decisionTableId" ], "variable": [ { "key": "decisionTableId", "value": "0lDHo0000008Pnt", "description": "Decision Table Id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Tue, 19 Sep 2023 13:22:05 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"errorCode\": null,\n \"errorMessage\": null,\n \"outcomeList\": [],\n \"outcomeType\": \"No Match\",\n \"successStatus\": true\n}" } ] } ] }, { "name": "lookup-tables", "item": [ { "name": "Retrieve lookup tables", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/lookup-tables?searchKey=my&usageType=Bre&lookupTypes=DecisionTable", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "lookup-tables" ], "query": [ { "key": "searchKey", "value": "my" }, { "key": "usageType", "value": "Bre" }, { "key": "lookupTypes", "value": "DecisionTable", "description": "Optional: Type of lookup table. Valid values are: DecisionMatrix, DecisionTable" } ] }, "description": "# 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 GET\n\n| Parameter Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| lookupTypes | String | Type of lookup table. Valid values are:

- DecisionMatrix

- DecisionTable | Optional | 59.0 |\n| searchKey | String | The search text entered by the user to retrieve a list of lookup tables. | Required | 59.0 |\n| usageType | String | Usage type of the lookup table. Valid values are:

- AiAccelerator​SubscriberChurn​Prediction—Used for Industries Einstein

- Bre—Used for Business Rules Engine

- CustomLoyalty—Used for Loyalty Management

- DefaultPricing—Used for Pricing Plans in Enterprise Product Catalog (EPC) by Communications Cloud

- Qualification—Used for Industries Communications, Media, and Energy (CME)

- RecordAlert—Used for Financial Services Cloud

- ShipAndDebit—Used for Manufacturing Cloud

- TierProcessing—Used for Loyalty Management

- TransactionJournal—Used for Loyalty Management

- WarrantyClaim—Used for Manufacturing Cloud | Required | 59.0 |\n\nResponse body for GET[Lookup Tables Result List](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_lookup_tables_result_list.htm)" }, "response": [ { "name": "404-BecauseVersion59.0NotPresentInTargetOrg", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/business-rules/lookup-tables?searchKey=my&usageType=Bre&lookupTypes=DecisionTable", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "business-rules", "lookup-tables" ], "query": [ { "key": "searchKey", "value": "my" }, { "key": "usageType", "value": "Bre" }, { "key": "lookupTypes", "value": "DecisionTable", "description": "Optional: Type of lookup table. Valid values are: DecisionMatrix, DecisionTable" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 06 Sep 2023 08:56:11 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "[\n {\n \"errorCode\": \"NOT_FOUND\",\n \"message\": \"The requested resource does not exist\"\n }\n]" } ] } ], "description": "[Lookup Tables (GET)](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_resources_bre_search_lookup_tables.htm)\n\n\"\"\n\n[Response Message](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/connect_responses_lookup_tables_result_list.htm)" } ], "description": "Business Rules Engine is a suite of services, components, and objects that can be used to create business rules that perform complex lookups and calculations. The key components of Business Rules Engine are expression sets, decision matrices, and decision tables.\n\n\"\"\n\nSee Developers Salesforce Help Docs: [Business Rules Engine](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/business_rules_engine.htm)\n\nSee Salesforce Help Docs: [Business Rules Engine](https://help.salesforce.com/s/articleView?id=sf.business_rules_engine.htm)\n\n# Business Rules Engine Business APIs\n\nBusiness Rules Engine Connect REST APIs help customers, partners, and ISVs integrate with Salesforce software and UIs.\n\nThe runtime service for Business Rules Engine components is exposed through Connect APIs.\n\n## Sign Up for a Developer Edition Org with Business Rules Engine\n\nIf you want to practice and try out the steps, you need a special Developer Edition org that contains Business Rules Engine and our sample data. Here’s how to get the free Developer Edition now.\n\n1. Sign up for a free Developer Edition org with [Business Rules Engine](https://trailhead.salesforce.com/promo/orgs/business-rules-engine).\n \n2. Fill out the form.\n \n 1. For Email, enter an active email address.\n \n 2. For Username, enter a username that looks like an email address and is unique. It doesn’t need to be a valid email account (for example, [yourname@hc4evah.com](https://mailto:yourname@hc4evah.com) is fine).\n \n3. Click **Sign me up**. A confirmation message appears.\n \n4. When you receive the activation email (this might take a few minutes), open it and click **Verify Account**.\n \n5. Complete your registration by setting your password and challenge question. \n **Tip:** Write down your username, password, and login URL for easy access later.\n \n\nYou are logged into your trial org. For more information on setting up Business Rules Engine and configuring your users, see [Set Up Business Rules Engine](https://help.salesforce.com/s/articleView?id=sf.set_up_business_rules_engine.htm&type=5).\n\nSpecfially this collection is designed to [answer](https://help.salesforce.com/s/articleView?id=sf.third_party_workflows.htm):\n\n\"\"" }, { "name": "Commerce Webstore", "item": [ { "name": "Cart Items", "item": [ { "name": "Add an item to a cart", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"productId\":\"\",\n \"quantity\":3,\n \"type\":\"Product\"\n}" }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/commerce/webstores/{{webstoreId}}/carts/:webCartId/cart-items?effectiveAccountId=", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "commerce", "webstores", "{{webstoreId}}", "carts", ":webCartId", "cart-items" ], "query": [ { "key": "effectiveAccountId", "value": "" } ], "variable": [ { "key": "webCartId", "value": null } ] } }, "response": [] } ] } ], "description": "Get, create, update, and delete your commerce data. Work with carts, orders, products, promotions, wishlists, and search settings.\n\nThis feature requires a [specific license](https://help.salesforce.com/s/articleView?id=sf.b2b_commerce_license.htm&type=5).\n\n📚 [B2B Commerce on Lightning Experience Resources in the Connect REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_commerce.htm)" }, { "name": "Fundraising", "item": [ { "name": "Gifts", "item": [ { "name": "Create Gifts", "protocolProfileBehavior": { "followAuthorizationHeader": true }, "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"gifts\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"commitmentId\": \"\",\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"organizationName\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.user@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10,\n \"amount\": 150.25\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n {\n \"amount\": 250.00,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"commitmentId\": \"\",\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"organizationName\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.user@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10,\n \"amount\": 150.25\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/gifts", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "gifts" ] }, "description": "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 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 with an empty string for the FieldName.\n \n\n## Validated Property Formats (an empty string is considered valid)\n\n- DateTime - YYYY-MM-DDTHH:MM:SSZ\n \n- Date - YYYY-MM-DD\n \n- Email - a valid formatted email address\n \n\n### Other Attributes:\n\n- OutreachSource -- This is optional. Be sure to create the OutreachSourceCode record in the system if passing a value\n \n- Will accept either an OutreachSourceCode.id (SalesforceId) or an OutreachSourceCode.Code.\n \n\n### Custom Fields:\n\n- The field_value can be a text string (inc. for a date data-type) or a numeric value (without quotes)\n \n- Do not include an empty collection or an empty fieldName in the request body" }, "response": [ { "name": "Status201-CreateGiftSuccess", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"gifts\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"commitmentId\": \"\",\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"organizationName\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.user@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10,\n \"amount\": 150.25\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n {\n \"amount\": 250.00,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"commitmentId\": \"\",\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"organizationName\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.user@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10,\n \"amount\": 150.25\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/gifts", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "gifts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 2,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"gifttransactiondesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"gifttransactiondesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "Status201-CreateGiftRequestValidationFailure", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"gifts\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"commitmentId\": \"123456\",\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.user@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n {\n \"amount\": 300.00,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"commitmentId\": \"\",\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.user@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/gifts", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "gifts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 1,\n \"failures\": 1,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"field\": \"id\",\n \"message\": \"\"\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"gifttransactiondesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "Status201-CreateGiftDatabaseFailure", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"gifts\": [\n {\n \"amount\": 5.00,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Paid\",\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"outreachSourceCode\": {\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.user@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n {\n \"amount\": 300.00,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Paid\",\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"outreachSourceCode\": {\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.user@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n {\n \"amount\": 300.00,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Paid\",\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"outreachSourceCode\": {\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.user@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/gifts", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "gifts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "// This is a scenario where there is a validation rule on the Gift Transaction object requiring the amount to be greater than 10.00. One database error occurs for the 5.00 transaction, causing the other two to be rolled back with success of false and no record links.\n{\n \"successes\": 0,\n \"failures\": 1,\n \"notProcessed\": 2,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"message\": \"Amount must be greater than 10.00\"\n }\n },\n {\n \"success\": false\n },\n {\n \"success\": false\n }\n ]\n}" }, { "name": "Status201-CreateGiftSuccessWithExternalIds", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"gifts\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"commitment\": {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n }\n },\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"campaign\": {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n }\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"organizationName\": \"\", // If donor type is \"organizational\"\n \"firstName\": \"David\", // if donor type is \"individual\"\n \"lastName\": \"Chavez\", // if donor type is \"individual\"\n \"phone\": \"510-434-8920\",\n \"email\": \"d.chavez@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"percent\": 10,\n \"amount\": 150.25\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n {\n \"amount\": 250.00,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"commitment\": {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n }\n },\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"campaign\": {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n }\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"organizationName\": \"\",\n \"firstName\": \"Luke\",\n \"lastName\": \"Smith\",\n \"phone\": \"510-434-8920\",\n \"email\": \"l.smith@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"percent\": 10,\n \"amount\": 150.25\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/gifts", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "gifts" ] } }, "_postman_previewlanguage": "Text", "header": null, "cookie": [], "body": "{\n \"successes\": 2,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"gifttransactiondesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ]\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"gifttransactiondesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ]\n }\n }\n ]\n}" }, { "name": "Status400-BadRequestError", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "// Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active.\n{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"gifts\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"commitmentId\": \"123456\",\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.user@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n {\n \"amount\": 300.00,\n \"currencyIsoCode\": \"USD\",\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"commitmentId\": \"\",\n \"paymentIdentifier\": \"1234\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.user@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2027\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"giftTransactionCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/gifts", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "gifts" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": " // Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active. Any non 200 error code would have a similar response structure.\n {\n \"errorCode\": \"UNKNOWN_EXCEPTION\",\n \"message\": \"Provide active duplicate matching rules on Account and Person Account for donor matching. -- industries.fundraisingops.connect.impl.validator.ValidatorUtil.validateMatchingMethod(ValidatorUtil.java:103)\"\n }" } ] }, { "name": "Update Gift Transaction Payments", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftTransactionId\": \"\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n },\n {\n \"giftTransactionId\": \"\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 1.00,\n \"gatewayTransactionFee\": 0.45,\n \"donorCoverAmount\": 20.00\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "transactions", "payment-updates" ] }, "description": "Update the gateway and processor metadata for gift transactions.\n\n## Required Attributes:\n\n- giftTransactionId\n \n- transactionStatus" }, "response": [ { "name": "Status201-UpdateTransactionPaymentSuccess", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftTransactionId\": \"\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n },\n {\n \"giftTransactionId\": \"\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 1.00,\n \"gatewayTransactionFee\": 0.45,\n \"donorCoverAmount\": 20.00\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "transactions", "payment-updates" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 2,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Status201-UpdateTransactionPaymentRequestValidationFailed", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftTransactionId\": \"INVALID GIFT TRANSACTION ID\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n },\n {\n \"giftTransactionId\": \"\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 1.00,\n \"gatewayTransactionFee\": 0.45,\n \"donorCoverAmount\": 20.00\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "transactions", "payment-updates" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 1,\n \"failures\": 1,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"field\": \"id\",\n \"message\": \"\"\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Status201-UpdateTransactionPaymentDatabaseFailure", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftTransactionId\": \"\",\n \"transactionStatus\": \"Invalid Transaction Status\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n },\n {\n \"giftTransactionId\": \"\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 1.00,\n \"gatewayTransactionFee\": 0.45,\n \"donorCoverAmount\": 20.00\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "transactions", "payment-updates" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "// This is a scenario where there is a validation rule on the Gift Transaction object requiring the donor cover amount to be less than 10.00. One database error occurs for the 10.50 cover amount, causing the other two to be rolled back with success of false and no record links.\n{\n \"successes\": 0,\n \"failures\": 1,\n \"notProcessed\": 1,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"message\": \"Donor cover amount must be less than 10.00\"\n }\n },\n {\n \"success\": false\n }\n ]\n}" }, { "name": "Status201-UpdateTransactionPaymentWithExternalIds", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftTransaction\": {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n }\n },\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "transactions", "payment-updates" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 1,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Status400-BadRequestError", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftTransactionId\": \"\",\n \"transactionStatus\": \"Paid\",\n \"processorReference\": \"string\",\n \"gatewayReference\": \"string\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\",\n \"processorTransactionFee\": 0.5,\n \"gatewayTransactionFee\": 0.25,\n \"donorCoverAmount\": 10.5\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/transactions/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "transactions", "payment-updates" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "// Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active. Any non 200 error code would have a similar response structure.\n{\n \"errorCode\": \"UNKNOWN_EXCEPTION\",\n \"message\": \"Provide active duplicate matching rules on Account and Person Account for donor matching. -- industries.fundraisingops.connect.impl.validator.ValidatorUtil.validateMatchingMethod(ValidatorUtil.java:103)\"\n}" } ] } ] }, { "name": "Commitments", "item": [ { "name": "Create Commitments", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments" ] }, "description": "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 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 wit an empty string for the FieldName.\n \n\n### Validated Property Formats (an empty string is considered valid)\n\n- DateTime - YYYY-MM-DDTHH:MM:SSZ\n- Date - YYYY-MM-DD\n- Email - a valid formatted email address\n \n\n#### Other Attributes\n\n- OutreachSource -- This is optional. Be sure to create the OutreachSourceCode record in the system if passing a value\n- Will accept **either** an OutreachSourceCode.id (SalesforceId) or an OutreachSourceCode.Code.\n \n\n#### Custom fields\n\n- The field_value can be a text string (inc. for a date data-type) or a numeric value (without quotes)\n- Do not include an empty collection or an empty fieldName in the request body" }, "response": [ { "name": "Status201-CreateCommitmentSuccess", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 1,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ],\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ],\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Status201-CreateCommitmentRequestValidationFailure", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"outreachSourceCode\": {\n \"id\": \"INVALID SOURCE CODE ID\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"organizationName\": \"test organization\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 0,\n \"failures\": 1,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"field\": \"outreachSourceCode.id\",\n \"message\": \"\"\n }\n }\n ]\n}" }, { "name": "Status201-CreateCommitmentDatabaseFailure", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 5.00,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"outreachSourceCode\": {\n \"id\": \"\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "// This is a scenario where there is a validation rule on the Gift Commitment Schedule object requiring the amount to be greater than 10.00. One database error occurs for the 5.00 commitment, causing the other two to be rolled back with success of false and no record links.\n{\n \"successes\": 0,\n \"failures\": 2,\n \"notProcessed\": 1,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"message\": \"Amount must be greater than 10.00\"\n }\n }\n ]\n}" }, { "name": "Status201-CreateCommitmentSuccessWithExternalIds", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 2500,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n }\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"firstName\": \"Luke\",\n \"lastName\": \"Smith\",\n \"phone\": \"510-434-8920\",\n \"email\": \"l.smith@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david chavez\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"firstName\": \"David\",\n \"lastName\": \"Chavez\",\n \"phone\": \"510-434-8920\",\n \"email\": \"d.chavez@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david chavez\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments" ] } }, "_postman_previewlanguage": "Text", "header": null, "cookie": [], "body": "{\n \"successes\": 2,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ],\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ],\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Status400-BadRequestError", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": " // Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active. Any non 200 error code would have a similar response structure.\n {\n \"errorCode\": \"UNKNOWN_EXCEPTION\",\n \"message\": \"Provide active duplicate matching rules on Account and Person Account for donor matching. -- industries.fundraisingops.connect.impl.validator.ValidatorUtil.validateMatchingMethod(ValidatorUtil.java:103)\"\n }" } ] }, { "name": "Create Pledge Commitments", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"type\": \"pledge\", \n \"currencyIsoCode\": \"USD\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments" ] }, "description": "Create pledge gift commitments with related new or matched donors, optional transaction designations, and payment instrument metadata. Supports custom fields for the donor account, gift commitment and gift commitment schedules.\n\n## Required Attributes:\n\n- commitments.amount\n \n- commitments.type\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 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 with an empty string for the FieldName.\n \n\n### Validated Property Formats (an empty string is considered valid)\n\n- DateTime - YYYY-MM-DDTHH:MM:SSZ\n \n- Date - YYYY-MM-DD\n \n- Email - a valid formatted email address\n \n\n#### Other Attributes\n\n- OutreachSource -- This is optional. Be sure to create the OutreachSourceCode record in the system if passing a value\n \n- Will accept **either** an OutreachSourceCode.id (SalesforceId) or an OutreachSourceCode.Code.\n \n\n#### Custom fields\n\n- The field_value can be a text string (inc. for a date data-type) or a numeric value (without quotes)\n \n- Do not include an empty collection or an empty fieldName in the request body" }, "response": [ { "name": "Status201-CreateCommitmentSuccess", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "/services/data/v61.0/connect/fundraising/commitments", "path": [ "services", "data", "v61.0", "connect", "fundraising", "commitments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 1,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ],\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ],\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Status201-CreateCommitmentRequestValidationFailure", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"outreachSourceCode\": {\n \"id\": \"INVALID SOURCE CODE ID\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"organizationName\": \"test organization\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 0,\n \"failures\": 1,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"field\": \"outreachSourceCode.id\",\n \"message\": \"\"\n }\n }\n ]\n}" }, { "name": "Status201-CreateCommitmentDatabaseFailure", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 5.00,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"outreachSourceCode\": {\n \"id\": \"\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "// This is a scenario where there is a validation rule on the Gift Commitment Schedule object requiring the amount to be greater than 10.00. One database error occurs for the 5.00 commitment, causing the other two to be rolled back with success of false and no record links.\n{\n \"successes\": 0,\n \"failures\": 2,\n \"notProcessed\": 1,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"message\": \"Amount must be greater than 10.00\"\n }\n }\n ]\n}" }, { "name": "Status201-CreateCommitmentSuccessWithExternalIds", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 2500,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n }\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"firstName\": \"Luke\",\n \"lastName\": \"Smith\",\n \"phone\": \"510-434-8920\",\n \"email\": \"l.smith@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david chavez\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"firstName\": \"David\",\n \"lastName\": \"Chavez\",\n \"phone\": \"510-434-8920\",\n \"email\": \"d.chavez@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david chavez\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n },\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments" ] } }, "_postman_previewlanguage": "Text", "header": null, "cookie": [], "body": "{\n \"successes\": 2,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ],\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n ],\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Status400-BadRequestError", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": " // Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active. Any non 200 error code would have a similar response structure.\n {\n \"errorCode\": \"UNKNOWN_EXCEPTION\",\n \"message\": \"Provide active duplicate matching rules on Account and Person Account for donor matching. -- industries.fundraisingops.connect.impl.validator.ValidatorUtil.validateMatchingMethod(ValidatorUtil.java:103)\"\n }" } ] }, { "name": "Update Commitments", "request": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n\"amount\": 150.25,\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"organizationName\": \"mini cat town\",\n \"firstName\": \"David\",\n \"lastName\": \"Taylor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"davidtaylor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david taylor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"classy\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", ":commitmentId" ], "variable": [ { "key": "commitmentId", "value": "" } ] }, "description": "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 with an empty string for the FieldName.\n \n\n## Validated Property Formats (an empty string is considered valid)\n\n- DateTime - YYYY-MM-DDTHH:MM:SSZ\n \n- Date - YYYY-MM-DD\n \n- Email - a valid formatted email address\n \n\n### Other Attributes\n\n- OutreachSource -- This is optional. Be sure to create the OutreachSourceCode record in the system if passing a value\n \n- Will accept either an OutreachSourceCode.id (SalesforceId) or an OutreachSourceCode.Code.\n \n\n### Custom Fields\n\n- The field_value can be a text string (inc. for a date data-type) or a numeric value (without quotes)\n \n- Do not include an empty collection or an empty fieldName in the request body" }, "response": [ { "name": "Status200-UpdateCommitmentSuccess", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n\"amount\": 150.25,\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"organizationName\": \"mini cat town\",\n \"firstName\": \"David\",\n \"lastName\": \"Taylor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"davidtaylor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david taylor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"classy\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", ":commitmentId" ], "variable": [ { "key": "commitmentId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n}" }, { "name": "Status200-UpdateCommitmentRequestValidationFailure", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"amount\": 150.25,\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"campaign\": {\n \"id\": \"\"\n },\n \"outreachSourceCode\": {\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", ":commitmentId" ], "variable": [ { "key": "commitmentId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"field\": \"donor.id\",\n \"message\": \"You cant include the donor ID in the request for the Gift Commitment Patch endpoint. Remove the ID from the Donor JSON request and try again.\"\n }\n ],\n \"success\": false\n}" }, { "name": "Status200-UpdateCommitmentDatabaseFailure", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"amount\": 150.25,\n \"transactionPeriod\": \"tomorrow\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"outreachSourceCode\": {\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", ":commitmentId" ], "variable": [ { "key": "commitmentId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"message\": \"Transaction Period: bad value for restricted picklist field: tomorrow\"\n }\n ],\n \"success\": false\n}" }, { "name": "Status200-UpdateCommitmentSuccessWithExternalIds", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n\"amount\": 150.25,\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"campaign\": {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n }\n },\n \"outreachSourceCode\": {\n \"id\": \"\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"organizationName\": \"ABC Inc.\",\n \"firstName\": \"David\",\n \"lastName\": \"Chavez\",\n \"phone\": \"510-434-8920\",\n \"email\": \"d.chavez@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david chavez\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"classy\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/{fieldValue}?externalIdField={fieldName}", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", "{fieldValue}" ], "query": [ { "key": "externalIdField", "value": "{fieldName}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n}" }, { "name": "Status400-BadRequestError", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"amount\": 150.25,\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"outreachSourceCode\": {\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", ":commitmentId" ], "variable": [ { "key": "commitmentId", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": " // Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active. Any non 200 error code would have a similar response structure.\n {\n \"errorCode\": \"UNKNOWN_EXCEPTION\",\n \"message\": \"Provide active duplicate matching rules on Account and Person Account for donor matching. -- industries.fundraisingops.connect.impl.validator.ValidatorUtil.validateMatchingMethod(ValidatorUtil.java:103)\"\n }" } ] }, { "name": "Update Commitment Payments", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftCommitmentId\": \"\",\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor 1\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"classy\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n },\n {\n \"giftCommitmentId\": \"\",\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor 2\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", "payment-updates" ] }, "description": "Update the future payment instrument metadata for active gift commitments.\n\n## Required Attributes:\n\n- giftCommitmentId\n \n- paymentInstrument.type" }, "response": [ { "name": "Status201-UpdateCommitmentSuccess", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftCommitmentId\": \"\",\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor 1\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"classy\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n },\n {\n \"giftCommitmentId\": \"\",\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor 2\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", "payment-updates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 2,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Status200-UpdateCommitmentRequestValidationFailure", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftCommitmentId\": \"INVALID COMMITMENT ID\",\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor 1\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"classy\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n },\n {\n \"giftCommitmentId\": \"\",\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor 2\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", "payment-updates" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 1,\n \"failures\": 1,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"field\": \"id\",\n \"message\": \"\"\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Status200-UpdateCommitmentDatabaseFailure", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftCommitmentId\": \"\",\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"classy\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n },\n {\n \"giftCommitmentId\": \"\",\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"google pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", "payment-updates" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "// This is a scenario where there is a validation rule on the Payment Instrument object requiring that the digitalWalletProvider cannot be \"Apple Pay\". One database error occurs for the 10.50 cover amount, causing the other two to be rolled back with success of false and no record links.\n{\n \"successes\": 0,\n \"failures\": 1,\n \"notProcessed\": 1,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"message\": \"\"\n }\n },\n {\n \"success\": false\n }\n ]\n}" }, { "name": "Status201-UpdateCommitmentExternalIds", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftCommitment\": {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n }\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david chavez\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"classy\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n },\n {\n \"giftCommitment\": {\n \"externalId\": {\n \"fieldName\": \"\",\n \"fieldValue\": \"\"\n }\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"luke smith\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", "payment-updates" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"successes\": 2,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/\",\n \"id\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Status400-BadRequestError", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"giftCommitmentId\": \"\",\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/payment-updates", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "fundraising", "commitments", "payment-updates" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": " // Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active. Any non 200 error code would have a similar response structure.\n {\n \"errorCode\": \"UNKNOWN_EXCEPTION\",\n \"message\": \"Provide active duplicate matching rules on Account and Person Account for donor matching. -- industries.fundraisingops.connect.impl.validator.ValidatorUtil.validateMatchingMethod(ValidatorUtil.java:103)\"\n }" } ] } ] } ], "description": "The Fundraising Business Process APIs empower teams to build robust integrations through industry standard tools. Instead of making multiple calls using multiple APIs to multiple objects, use our composite Fundraising BP API to send over a single, complex payload - and let us do the rest. Developer-friendly APIs do not require a detailed and complete understanding of the NPC data model, which greatly simplifies integrations. Automatic record matching, batch processing of fields, bulk support, and dynamic mapping of data to custom fields enables scalability and flexibility for customers and partners alike. Five robust endpoints are currently available to:\n\n- Create bulk gift transactions with related donor and designations\n- Create bulk gift commitments with related donor, schedule, and default designations\n- Modify the future recurring schedule on a gift commitment\n- Apply payment update metadata to gift transactions and future gift commitment installments\n \n\nThe Fundraising Business Process APIs are available as a standard Salesforce Connect API REST endpoint as well as through Apex.\n\n📚 [Fundraising Business APIs](https://developer.salesforce.com/docs/atlas.en-us.nonprofit_cloud.meta/nonprofit_cloud/npc_fundraising_business_api_rest_reference.htm)" } ], "description": "[Industries Common Resources Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.246.0.industries_reference.meta/industries_reference/)" }, { "name": "Einstein", "item": [ { "name": "Generate Response Based on Prompt Template", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"isPreview\": \"false\",\n \"inputParams\": {\n \"valueMap\": {\n \n }\n },\n \"additionalConfig\": {\n \"numGenerations\": 1,\n \"temperature\": 0,\n \"frequencyPenalty\": 0.0,\n \"presencePenalty\": 0.0,\n \"additionalParameters\": {},\n \"applicationName\": \"PromptBuilderPreview\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/einstein/prompt-templates/:PROMPT_TEMPLATE_API_NAME/generations", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "einstein", "prompt-templates", ":PROMPT_TEMPLATE_API_NAME", "generations" ], "variable": [ { "key": "PROMPT_TEMPLATE_API_NAME", "value": "", "description": "API name of the prompt template to invoke" } ] }, "description": "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))." }, "response": [ { "name": "Generate Response Based on Prompt Template", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"isPreview\": \"false\",\n \"inputParams\": {\n \"valueMap\": {\n \"Input:Property\": {\n \"value\": {\n \"id\": \"a011Q00001EQYXOQA5\"\n }\n }\n }\n },\n \"additionalConfig\": {\n \"numGenerations\": 1,\n \"temperature\": 0,\n \"frequencyPenalty\": 0.0,\n \"presencePenalty\": 0.0,\n \"additionalParameters\": {},\n \"applicationName\": \"PromptBuilderPreview\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/einstein/prompt-templates/Generate_Social_Media_Posts/generations", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "einstein", "prompt-templates", "Generate_Social_Media_Posts", "generations" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 27 Mar 2024 10:30:55 GMT" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Set-Cookie", "value": "CookieConsentPolicy=0:1; path=/; expires=Thu, 27-Mar-2025 10:30:46 GMT; Max-Age=31536000; secure" }, { "key": "Set-Cookie", "value": "LSKey-c$CookieConsentPolicy=0:1; path=/; expires=Thu, 27-Mar-2025 10:30:46 GMT; Max-Age=31536000; secure" }, { "key": "Set-Cookie", "value": "BrowserId=EmiKg-wlEe6gDIWbBKrQ-g; domain=.salesforce.com; path=/; expires=Thu, 27-Mar-2025 10:30:46 GMT; Max-Age=31536000" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Origin-Trial", "value": "AqlAE64ET63tVSana3qdVkfkPAgyUhY8GwcehUlpqv067CevOpumeNUlx9YouLkBxJ0CT+EwIb8/SiNbF2NGvwYAAABfeyJvcmlnaW4iOiJodHRwczovL3NhbGVzZm9yY2UuY29tOjQ0MyIsImZlYXR1cmUiOiJUcGNkIiwiZXhwaXJ5IjoxNzM1MzQzOTk5LCJpc1N1YmRvbWFpbiI6dHJ1ZX0=" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Server", "value": "sfdcedge" }, { "key": "X-SFDC-Request-Id", "value": "7070edfcd5d02a0d047af20b8dccf83e" } ], "cookie": [], "body": "{\n \"generations\": [\n {\n \"parameters\": \"{finish_reason=stop, index=0, logprobs=null}\",\n \"responseId\": \"893db990-7acb-4845-ad65-54d82606ca65\",\n \"text\": \"{\\n "twitter": "🌟 Exciting new listing! Explore our luxurious property, [Provide:{PROPERTY NAME}], featuring [Provide:{BEDS}] beds, [Provide:{BATHS}] baths, and an asking price of [Provide:{ASKING PRICE}]. Click the link for a sneak peek! [Provide:{PICTURE}]",\\n "linkedin": "🌟🌟 Don't miss out on this incredible opportunity! Discover the stunning property, [Provide:{PROPERTY NAME}], offering [Provide:{BEDS}] beds, [Provide:{BATHS}] baths, and an asking price of [Provide:{ASKING PRICE}]. Click the link below to see more! [Provide:{PICTURE}]",\\n "blockkit": {\\n "blocks": [\\n {\\n "type": "section",\\n "text": {\\n "type": "mrkdwn",\\n "text": "*Luxury Property Alert!* \n\n🌟🌟🌟\n\nIntroducing [Provide:{PROPERTY NAME}], a magnificent home with [Provide:{BEDS}] beds and [Provide:{BATHS}] baths. Priced at [Provide:{ASKING PRICE}]."\\n },\\n "accessory": {\\n "type": "image",\\n "image_url": "[Provide:{PICTURE}]",\\n "alt_text": "Luxury Property"\\n }\\n },\\n {\\n "type": "divider"\\n },\\n {\\n "type": "actions",\\n "elements": [\\n {\\n "type": "button",\\n "text": {\\n "type": "plain_text",\\n "text": "View Property",\\n "emoji": true\\n },\\n "url": "https://d1q000001ewauuaq-dev-ed.develop.lightning.force.com/[Provide:{RECORD ID}]"\\n }\\n ]\\n }\\n ]\\n }\\n}\"\n }\n ],\n \"parameters\": null,\n \"prompt\": \"You're the community manager for Dreamhouse, a real estate agency that sells luxury properties. \\nCreate social media posts for twitter, linkedin and slack (block kit format) describing the property.\\n\\nInstructions:\\n"""\\nUse clear, concise, and straightforward language using the active voice and strictly avoiding the use of filler words and phrases and redundant language.\\nMake sure the response is valid JSON.\\nWhen you generate the posts, include the name of the property, [Provide:{PROPERTY NAME}], and explain the characteristics of the house, such as [Provide:{BATHS}], [Provide:{BEDS}]and[Provide:{ASKING PRICE}]. Also include a link to the picture of the property, [Provide:{PICTURE}]. \\n\\nThe twitter post should include emojis.\\nThe linkedin post should include several emojis and bullets, and also have a special output formatting: Text render environment only supports Unicode and emoji. Use symbols from Unicode’s Mathematical Alphanumeric Symbols block liberally to produce facsimiles of bold, italics, line separation, and other formatting. Examples for a sample sentence:\\n\\nitalics sans: 𝘛𝘩𝘦 𝘘𝘶𝘪𝘤𝘬 𝘉𝘳𝘰𝘸𝘯 𝘍𝘰𝘹 𝘑𝘶𝘮𝘱𝘦𝘥 𝘖𝘷𝘦𝘳 𝘵𝘩𝘦 𝘭𝘢𝘻𝘺 𝘥𝘰𝘨.\\nbold sans: 𝗧𝗵𝗲 𝗤𝘂𝗶𝗰𝗸 𝗕𝗿𝗼𝘄𝗻 𝗙𝗼𝘅 𝗝𝘂𝗺𝗽𝗲𝗱 𝗢𝘃𝗲𝗿 𝘁𝗵𝗲 𝗹𝗮𝘇𝘆 𝗱𝗼𝗴.\\nbold italic sans: 𝙏𝙝𝙚 𝙌𝙪𝙞𝙘𝙠 𝘽𝙧𝙤𝙬𝙣 𝙁𝙤𝙭 𝙅𝙪𝙢𝙥𝙚𝙙 𝙊𝙫𝙚𝙧 𝙩𝙝𝙚 𝙡𝙖𝙯𝙮 𝙙𝙤𝙜.\\nitalics serif: 𝑇ℎ𝑒 𝑄𝑢𝑖𝑐𝑘 𝐵𝑟𝑜𝑤𝑛 𝐹𝑜𝑥 𝐽𝑢𝑚𝑝𝑒𝑑 𝑂𝑣𝑒𝑟 𝑡ℎ𝑒 𝑙𝑎𝑧𝑦 𝑑𝑜𝑔.\\n\\nThe block kit code should be valid block kit code.\\nWhen you generate the block kit code: \\n- Add several sections. \\n- Include the name of the property, [Provide:{PROPERTY NAME}], and explain the characteristics of the house, such as [Provide:{BATHS}], [Provide:{BEDS}] and [Provide:{ASKING PRICE}]. \\n- Include a the picture of the property, which image_url is [Provide:{PICTURE}]. \\n- Include a button which url points to https://d1q000001ewauuaq-dev-ed.develop.lightning.force.com/[Provide:{RECORD ID}]\\n- Include emoticons so the post is more visual.\\n\\nExample of block kit code:\\n\\n{\\n "blocks": [\\n {\\n "type": "section",\\n "text": {\\n "type": "mrkdwn",\\n "text": "Hello, Assistant to the Regional Manager Dwight! *Michael Scott* wants to know where you'd like to take the Paper Company investors to dinner tonight.\n\n *Please select a restaurant:*"\\n }\\n },\\n {\\n "type": "divider"\\n },\\n {\\n "type": "section",\\n "text": {\\n "type": "mrkdwn",\\n "text": "*Farmhouse Thai Cuisine*\n:star::star::star::star: 1528 reviews\n They do have some vegan options, like the roti and curry, plus they have a ton of salad stuff and noodles can be ordered without meat!! They have something for everyone here"\\n },\\n "accessory": {\\n "type": "image",\\n "image_url": "https://s3-media3.fl.yelpcdn.com/bphoto/c7ed05m9lC2EmA3Aruue7A/o.jpg",\\n "alt_text": "alt text for image"\\n }\\n },\\n {\\n "type": "section",\\n "text": {\\n "type": "mrkdwn",\\n "text": "*Kin Khao*\n:star::star::star::star: 1638 reviews\n The sticky rice also goes wonderfully with the caramelized pork belly, which is absolutely melt-in-your-mouth and so soft."\\n },\\n "accessory": {\\n "type": "image",\\n "image_url": "https://s3-media2.fl.yelpcdn.com/bphoto/korel-1YjNtFtJlMTaC26A/o.jpg",\\n "alt_text": "alt text for image"\\n }\\n },\\n {\\n "type": "section",\\n "text": {\\n "type": "mrkdwn",\\n "text": "*Ler Ros*\n:star::star::star::star: 2082 reviews\n I would really recommend the Yum Koh Moo Yang - Spicy lime dressing and roasted quick marinated pork shoulder, basil leaves, chili & rice powder."\\n },\\n "accessory": {\\n "type": "image",\\n "image_url": "https://s3-media2.fl.yelpcdn.com/bphoto/DawwNigKJ2ckPeDeDM7jAg/o.jpg",\\n "alt_text": "alt text for image"\\n }\\n },\\n {\\n "type": "divider"\\n },\\n {\\n "type": "actions",\\n "elements": [\\n {\\n "type": "button",\\n "text": {\\n "type": "plain_text",\\n "text": "Farmhouse",\\n "emoji": true\\n },\\n "value": "click_me_123"\\n },\\n {\\n "type": "button",\\n "text": {\\n "type": "plain_text",\\n "text": "Kin Khao",\\n "emoji": true\\n },\\n "value": "click_me_123",\\n "url": "https://google.com"\\n },\\n {\\n "type": "button",\\n "text": {\\n "type": "plain_text",\\n "text": "Ler Ros",\\n "emoji": true\\n },\\n "value": "click_me_123",\\n "url": "https://google.com"\\n }\\n ]\\n }\\n ]\\n}\\n\\nThe response should have the next format:\\n{\\n "twitter": [here goes the twitter post, that should have less than 280 characters],\\n "linkedin": [here goes the linkedin post, that should have between 1500 and 2000 characters], \\n "blockkit": [here goes the block kit post], \\n}\\n\\n"""\\n\\nNow generate the posts.\\n\\n\\n\",\n \"promptTemplateDevName\": \"Generate_Social_Media_Posts\",\n \"requestId\": \"chatcmpl-97KqPl1TEiOgMdnKKPQ9aVs7rPJGr\"\n}" } ] }, { "name": "Run agent test", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"aiEvaluationDefinitionName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/einstein/ai-evaluations/runs", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "einstein", "ai-evaluations", "runs" ] }, "description": "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))." }, "response": [ { "name": "Run agent test", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"aiEvaluationDefinitionName\": \"Employee_agent_tests\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/einstein/ai-evaluations/runs", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "einstein", "ai-evaluations", "runs" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 10 Sep 2025 13:46:14 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Sforce-Limit-Info", "value": "api-usage=183/5000000" }, { "key": "Set-Cookie", "value": "CookieConsentPolicy=0:1; path=/; expires=Thu, 10-Sep-2026 13:46:14 GMT; Max-Age=31536000; secure" }, { "key": "Set-Cookie", "value": "LSKey-c$CookieConsentPolicy=0:1; path=/; expires=Thu, 10-Sep-2026 13:46:14 GMT; Max-Age=31536000; secure" }, { "key": "Set-Cookie", "value": "BrowserId=hIZ7eo5MEfCnxfmijQif_g; domain=.salesforce.com; path=/; expires=Thu, 10-Sep-2026 13:46:14 GMT; Max-Age=31536000; secure; SameSite=None" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Server", "value": "sfdcedge" }, { "key": "X-SFDC-Request-Id", "value": "543c8913aa732b136328d39c8546b5ac" }, { "key": "X-Request-Id", "value": "543c8913aa732b136328d39c8546b5ac" } ], "cookie": [], "body": "{\n \"runId\": \"4KBAU0000002oK54AI\",\n \"status\": \"NEW\"\n}" } ] }, { "name": "Get test status", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/einstein/ai-evaluations/runs/:runId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "einstein", "ai-evaluations", "runs", ":runId" ], "variable": [ { "key": "runId", "value": "", "description": "Evaluation ID" } ] }, "description": "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))." }, "response": [ { "name": "Get test status", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/einstein/ai-evaluations/runs/:runId", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "einstein", "ai-evaluations", "runs", ":runId" ], "variable": [ { "key": "runId", "value": "4KBAU0000002oK54AI", "description": "Evaluation ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 10 Sep 2025 13:46:26 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Set-Cookie", "value": "CookieConsentPolicy=0:1; path=/; expires=Thu, 10-Sep-2026 13:46:26 GMT; Max-Age=31536000; secure" }, { "key": "Set-Cookie", "value": "LSKey-c$CookieConsentPolicy=0:1; path=/; expires=Thu, 10-Sep-2026 13:46:26 GMT; Max-Age=31536000; secure" }, { "key": "Set-Cookie", "value": "BrowserId=i6chMI5MEfCjGPkElbnd3Q; domain=.salesforce.com; path=/; expires=Thu, 10-Sep-2026 13:46:26 GMT; Max-Age=31536000; secure; SameSite=None" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Sforce-Limit-Info", "value": "api-usage=183/5000000" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Server", "value": "sfdcedge" }, { "key": "X-SFDC-Request-Id", "value": "9c6b1b17f16e5e4b538e836eb8def249" }, { "key": "X-Request-Id", "value": "9c6b1b17f16e5e4b538e836eb8def249" }, { "key": "X-SFDC-Edge-Cache", "value": "MISS" } ], "cookie": [], "body": "{\n \"startTime\": \"2025-09-10T13:46:14.000Z\",\n \"status\": \"IN_PROGRESS\"\n}" } ] }, { "name": "Get test results", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/einstein/ai-evaluations/runs/:runId/results", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "einstein", "ai-evaluations", "runs", ":runId", "results" ], "variable": [ { "key": "runId", "value": "", "description": "Evaluation ID" } ] }, "description": "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))." }, "response": [ { "name": "Get test results", "originalRequest": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/einstein/ai-evaluations/runs/:runId/results", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "einstein", "ai-evaluations", "runs", ":runId", "results" ], "variable": [ { "key": "runId", "value": "4KBAU0000002oK54AI", "description": "Evaluation ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Wed, 10 Sep 2025 13:48:41 GMT" }, { "key": "Content-Type", "value": "application/json", "description": "" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Set-Cookie", "value": "CookieConsentPolicy=0:1; path=/; expires=Thu, 10-Sep-2026 13:48:38 GMT; Max-Age=31536000; secure" }, { "key": "Set-Cookie", "value": "LSKey-c$CookieConsentPolicy=0:1; path=/; expires=Thu, 10-Sep-2026 13:48:38 GMT; Max-Age=31536000; secure" }, { "key": "Set-Cookie", "value": "BrowserId=2uMY_45MEfCq_Pt-gustfQ; domain=.salesforce.com; path=/; expires=Thu, 10-Sep-2026 13:48:38 GMT; Max-Age=31536000; secure; SameSite=None" }, { "key": "Sforce-Limit-Info", "value": "api-usage=185/5000000" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Server", "value": "sfdcedge" }, { "key": "X-SFDC-Request-Id", "value": "238f419aa5f27f4e5a4cb714c7dfde45" }, { "key": "X-Request-Id", "value": "238f419aa5f27f4e5a4cb714c7dfde45" }, { "key": "X-SFDC-Edge-Cache", "value": "MISS" } ], "cookie": [], "body": "{\n \"endTime\": \"2025-09-10T13:48:31Z\",\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"subjectName\": \"Employee_agent_tests\",\n \"testCases\": [\n {\n \"endTime\": \"2025-09-10T13:46:30Z\",\n \"generatedData\": {\n \"actionsSequence\": \"[]\",\n \"invokedActions\": \"[[]]\",\n \"outcome\": \"To check the weather forecast at the resort, please provide the date you'd like to check.\",\n \"sessionId\": \"019933e0-8597-70de-912b-359082a322b2\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"What's the weather forecast at the resort?\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 1,\n \"testResults\": [\n {\n \"actualValue\": \"[]\",\n \"endTime\": \"2025-09-10T13:46:31Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"[]\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"To check the weather forecast at the resort, please provide the date you'd like to check.\",\n \"endTime\": \"2025-09-10T13:46:31Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Please provide a future date to check the weather forecast.\",\n \"metricExplainability\": \"The BOT RESPONSE correctly prompts the user for the necessary information (a future date) to provide the weather forecast, aligning well with the EXPECTED RESPONSE. It is clear and does not include irrelevant information.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"PASS\",\n \"score\": 5,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:46:31Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:31Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is incomplete as it does not provide the weather forecast at the resort, instead it asks for the date to check the forecast.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:31Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is easy to understand, and it does not contain any significant grammar errors. The answer is also relevant to the question asked.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:31Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"PASS\",\n \"score\": 5,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:31Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 2352,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:46:40Z\",\n \"generatedData\": {\n \"actionsSequence\": \"['Check_Weather_179AU00000038U5']\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[{"function":{"name":"Check_Weather_179AU00000038U5","input":{"dateToCheck":"2025-01-01"},"output":{}},"executionLatency":539}]]\",\n \"outcome\": \"Hmm, it looks like I wasn’t able to retrieve the weather forecast for January 1st, 2025. The system I’d normally use to check this information didn’t respond as expected.\\n\\nYou might want to try checking a weather app or website closer to the date for the most accurate forecast. Let me know if there’s anything else I can help with! (Session ID: 019933e0-858f-7170-9bd7-5564c5e4c85a)\",\n \"sessionId\": \"019933e0-858f-7170-9bd7-5564c5e4c85a\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"What's the weather forecast for Jan 1st, 2025 at the resort?\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 2,\n \"testResults\": [\n {\n \"actualValue\": \"['Check_Weather_179AU00000038U5']\",\n \"endTime\": \"2025-09-10T13:46:42Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"['Check_Weather']\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Hmm, it looks like I wasn’t able to retrieve the weather forecast for January 1st, 2025. The system I’d normally use to check this information didn’t respond as expected.\\n\\nYou might want to try checking a weather app or website closer to the date for the most accurate forecast. Let me know if there’s anything else I can help with! (Session ID: 019933e0-858f-7170-9bd7-5564c5e4c85a)\",\n \"endTime\": \"2025-09-10T13:46:42Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"I can only provide weather forecasts for future dates. Please provide a future date.\",\n \"metricExplainability\": \"The BOT RESPONSE fails to address the user's QUERY for a specific forecast date and incorrectly states that it cannot retrieve the information. It does not align with the EXPECTED RESPONSE, which simply asks for a future date, indicating a misunderstanding of the user's request.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:46:42Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:42Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is very incomplete as it does not provide any information about the weather forecast for Jan 1st, 2025 at the resort, which is the main request. It only mentions that the system did not respond as expected and suggests checking a weather app or website.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:42Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is generally understandable, but it contains a few grammar errors and sections that are unclear. The phrase 'The system I’d normally use to check this information didn’t respond as expected' is a bit confusing, and the suggestion to check a weather app or website closer to the date is not directly related to the original question.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"PASS\",\n \"score\": 3,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:42Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"PASS\",\n \"score\": 5,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:42Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 11154,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:46:33Z\",\n \"generatedData\": {\n \"actionsSequence\": \"['Check_Weather_179AU00000038U5']\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[{"function":{"name":"Check_Weather_179AU00000038U5","input":{"dateToCheck":"2025-09-11"},"output":{"weather":{"minTemperatureF":60.4,"minTemperatureC":15.8,"maxTemperatureF":78.3,"maxTemperatureC":25.7,"iconName":"rain","description":"On September 11, temperature will be between 15.8°C (60.4°F) and 25.7°C (78.3°F) at Coral Cloud Reso"}}},"executionLatency":510}]]\",\n \"outcome\": \"Here's the weather forecast for tomorrow at Coral Cloud Resorts. Let me know if you need anything else!\\n{minTemperatureF=60.4, minTemperatureC=15.8, maxTemperatureF=78.3, maxTemperatureC=25.7, iconName=rain, description=On September 11, temperature will be between 15.8°C (60.4°F) and 25.7°C (78.3°F) at Coral Cloud Resorts.}\",\n \"sessionId\": \"019933e0-8571-720f-a404-546c9c2af263\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"What's the weather forecast for tomorrow at the resort?\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 3,\n \"testResults\": [\n {\n \"actualValue\": \"['Check_Weather_179AU00000038U5']\",\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"['Check_Weather']\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Here's the weather forecast for tomorrow at Coral Cloud Resorts. Let me know if you need anything else!\\n{minTemperatureF=60.4, minTemperatureC=15.8, maxTemperatureF=78.3, maxTemperatureC=25.7, iconName=rain, description=On September 11, temperature will be between 15.8°C (60.4°F) and 25.7°C (78.3°F) at Coral Cloud Resorts.}\",\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"The weather is expected to be sunny with a high of 85°F.\",\n \"metricExplainability\": \"The BOT RESPONSE provides detailed temperature information and conditions, but it does not align with the EXPECTED RESPONSE, which specifies a sunny forecast with a high of 85°F. The response includes unnecessary details and does not match the expected weather conditions.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"FAILURE\",\n \"score\": 2,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer provides the weather forecast for tomorrow at the resort, including the minimum and maximum temperatures in both Celsius and Fahrenheit, as well as the icon name and description. The answer does not miss any important pieces of information, ensuring clarity and accuracy.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is generally understandable, but it contains some sections that are unclear, such as the use of 'Coral Cloud Resorts' twice, and the mention of 'On September 11' which is not relevant to the weather forecast for tomorrow. The answer also contains a few grammar errors, such as the use of 'Let me know if you need anything else!' which is not relevant to the weather forecast.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"PASS\",\n \"score\": 3,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 2788,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:46:32Z\",\n \"generatedData\": {\n \"actionsSequence\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5']\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[{"function":{"name":"Get_Customer_From_Email_or_Membership_Number_179AU00000038U5","input":{"customerEmail":"nonexistent@example.com"},"output":{"contactId":null,"contactRecord":null}},"executionLatency":237}]]\",\n \"outcome\": \"I couldn't find any contact details associated with the email address "nonexistent@example.com". Let me know if you'd like me to try searching with a different email or membership number!\",\n \"sessionId\": \"019933e0-85a6-74d0-bfa4-841e8c8a03d3\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"Can you provide the details for the contact with email nonexistent@example.com?\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 4,\n \"testResults\": [\n {\n \"actualValue\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5']\",\n \"endTime\": \"2025-09-10T13:46:33Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"['Get_Customer_From_Email_or_Membership_Number']\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"I couldn't find any contact details associated with the email address "nonexistent@example.com". Let me know if you'd like me to try searching with a different email or membership number!\",\n \"endTime\": \"2025-09-10T13:46:33Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"I couldn't find any contact with the email nonexistent@example.com. Please check the email and try again.\",\n \"metricExplainability\": \"The BOT RESPONSE is aligned with the EXPECTED RESPONSE in that it indicates the contact details associated with the provided email address were not found. However, it adds an unnecessary prompt for the user to try a different email or membership number, which is not part of the EXPECTED RESPONSE. Therefore, it slightly deviates from the expected outcome.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:46:33Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:33Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is very incomplete as it does not provide any contact details for the email address, and instead asks for further input.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:33Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is easy to understand, and the grammar is correct. The answer clearly states that no contact details were found and offers to try searching with a different email or membership number, which is a coherent response.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:33Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"PASS\",\n \"score\": 5,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:33Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 2512,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:46:33Z\",\n \"generatedData\": {\n \"actionsSequence\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5']\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[{"function":{"name":"Get_Customer_From_Email_or_Membership_Number_179AU00000038U5","input":{"customerEmail":"nediheinsius@example.com"},"output":{"contactId":"003AU00001J7b4GYAR","contactRecord":{"sObjectInfo":{"apiName":"Contact","label":"Contact"},"id":"003AU00001J7b4GYAR","data":{"AccountId":null,"AssistantName":null,"AssistantPhone":null,"Average_Room_Cost__c":null,"Birthdate":"2042-05-03","CleanStatus":"Pending","ContactSource":null,"CreatedById":"005AU00000OrYkDYAV","CreatedDate":"2025-09-09T13:59:41.000+0000","Department":null,"Description":null,"DoNotCall":false,"Email":"nediheinsius@example.com","EmailBouncedDate":null,"EmailBouncedReason":null,"External_Id__c":"10003177","Fax":null,"FirstName":"Nedi","GenderIdentity":null,"Guest_Type__c":"Business and Pleasure Travelers","HasOptedOutOfEmail":false,"HasOptedOutOfFax":false,"HomePhone":null,"Id":"003AU00001J7b4GYAR","IndividualId":null,"Interest1__c":"Fitness & Exercise","Interest2__c":"Nightlife & Entertainment","Interest3__c":"Nature & Eco Tours","IsDeleted":false,"IsEmailBounced":false,"Jigsaw":null,"JigsawContactId":null,"Languages__c":null,"LastActivityDate":null,"LastCURequestDate":null,"LastCUUpdateDate":null,"LastModifiedById":"005AU00000OrYkDYAV","LastModifiedDate":"2025-09-09T13:59:53.000+0000","LastName":"Heinsius","LastReferencedDate":"2025-09-09T13:59:41.000+0000","LastViewedDate":"2025-09-09T13:59:41.000+0000","LeadSource":"Partnerships","Level__c":null,"Lifetime_Experience_Bookings__c":12.0,"Lifetime_Reservations__c":null,"Lifetime_Value__c":null,"MailingAddress":{"city":"Peoria","country":"United States","geocodeAccuracy":null,"latitude":null,"longitude":null,"postalCode":"85383","state":"Arizona","street":"75563 Farwell Drive"},"MailingCity":"Peoria","MailingCountry":"United States","MailingGeocodeAccuracy":null,"MailingLatitude":null,"MailingLongitude":null,"MailingPostalCode":"85383","MailingState":"Arizona","MailingStreet":"75563 Farwell Drive","MasterRecordId":null,"Maximum_Room_Cost__c":null,"Membership_Number__c":"10003177","Minimum_Room_Cost__c":null,"MobilePhone":"196-794-6794","Name":"Nedi Heinsius","Next_Check_in_Date__c":null,"OtherAddress":null,"OtherCity":null,"OtherCountry":null,"OtherGeocodeAccuracy":null,"OtherLatitude":null,"OtherLongitude":null,"OtherPhone":null,"OtherPostalCode":null,"OtherState":null,"OtherStreet":null,"OwnerId":"005AU00000OrYkDYAV","Phone":null,"PhotoUrl":"/services/images/photo/003AU00001J7b4GYAR","Photo_URL__c":null,"Preferred_Name__c":"Nedi","Pronouns":null,"ReportsToId":null,"Salutation":null,"SystemModstamp":"2025-09-09T13:59:53.000+0000","Title":null}}}},"executionLatency":256}]]\",\n \"outcome\": \"Here are the contact details for the provided email. Let me know if you need further assistance!\\n{sObjectInfo={apiName=Contact, label=Contact}, id=003AU00001J7b4GYAR, data={AccountId=null, AssistantName=null, AssistantPhone=null, Average_Room_Cost__c=null, Birthdate=2042-05-03, CleanStatus=Pending, ContactSource=null, CreatedById=005AU00000OrYkDYAV, CreatedDate=2025-09-09T13:59:41.000+0000, Department=null, Description=null, DoNotCall=false, Email=nediheinsius@example.com, EmailBouncedDate=null, EmailBouncedReason=null, External_Id__c=10003177, Fax=null, FirstName=Nedi, GenderIdentity=null, Guest_Type__c=Business and Pleasure Travelers, HasOptedOutOfEmail=false, HasOptedOutOfFax=false, HomePhone=null, Id=003AU00001J7b4GYAR, IndividualId=null, Interest1__c=Fitness & Exercise, Interest2__c=Nightlife & Entertainment, Interest3__c=Nature & Eco Tours, IsDeleted=false, IsEmailBounced=false, Jigsaw=null, JigsawContactId=null, Languages__c=null, LastActivityDate=null, LastCURequestDate=null, LastCUUpdateDate=null, LastModifiedById=005AU00000OrYkDYAV, LastModifiedDate=2025-09-09T13:59:53.000+0000, LastName=Heinsius, LastReferencedDate=2025-09-09T13:59:41.000+0000, LastViewedDate=2025-09-09T13:59:41.000+0000, LeadSource=Partnerships, Level__c=null, Lifetime_Experience_Bookings__c=12.0, Lifetime_Reservations__c=null, Lifetime_Value__c=null, MailingAddress={city=Peoria, country=United States, geocodeAccuracy=null, latitude=null, longitude=null, postalCode=85383, state=Arizona, street=75563 Farwell Drive}, MailingCity=Peoria, MailingCountry=United States, MailingGeocodeAccuracy=null, MailingLatitude=null, MailingLongitude=null, MailingPostalCode=85383, MailingState=Arizona, MailingStreet=75563 Farwell Drive, MasterRecordId=null, Maximum_Room_Cost__c=null, Membership_Number__c=10003177, Minimum_Room_Cost__c=null, MobilePhone=196-794-6794, Name=Nedi Heinsius, Next_Check_in_Date__c=null, OtherAddress=null, OtherCity=null, OtherCountry=null, OtherGeocodeAccuracy=null, OtherLatitude=null, OtherLongitude=null, OtherPhone=null, OtherPostalCode=null, OtherState=null, OtherStreet=null, OwnerId=005AU00000OrYkDYAV, Phone=null, PhotoUrl=/services/images/photo/003AU00001J7b4GYAR, Photo_URL__c=null, Preferred_Name__c=Nedi, Pronouns=null, ReportsToId=null, Salutation=null, SystemModstamp=2025-09-09T13:59:53.000+0000, Title=null}}\",\n \"sessionId\": \"019933e0-8586-7a38-8b9b-36d0271d9c82\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"Can you find the contact details for the email nediheinsius@example.com?\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 5,\n \"testResults\": [\n {\n \"actualValue\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5']\",\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"['Get_Customer_From_Email_or_Membership_Number']\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Here are the contact details for the provided email. Let me know if you need further assistance!\\n{sObjectInfo={apiName=Contact, label=Contact}, id=003AU00001J7b4GYAR, data={AccountId=null, AssistantName=null, AssistantPhone=null, Average_Room_Cost__c=null, Birthdate=2042-05-03, CleanStatus=Pending, ContactSource=null, CreatedById=005AU00000OrYkDYAV, CreatedDate=2025-09-09T13:59:41.000+0000, Department=null, Description=null, DoNotCall=false, Email=nediheinsius@example.com, EmailBouncedDate=null, EmailBouncedReason=null, External_Id__c=10003177, Fax=null, FirstName=Nedi, GenderIdentity=null, Guest_Type__c=Business and Pleasure Travelers, HasOptedOutOfEmail=false, HasOptedOutOfFax=false, HomePhone=null, Id=003AU00001J7b4GYAR, IndividualId=null, Interest1__c=Fitness & Exercise, Interest2__c=Nightlife & Entertainment, Interest3__c=Nature & Eco Tours, IsDeleted=false, IsEmailBounced=false, Jigsaw=null, JigsawContactId=null, Languages__c=null, LastActivityDate=null, LastCURequestDate=null, LastCUUpdateDate=null, LastModifiedById=005AU00000OrYkDYAV, LastModifiedDate=2025-09-09T13:59:53.000+0000, LastName=Heinsius, LastReferencedDate=2025-09-09T13:59:41.000+0000, LastViewedDate=2025-09-09T13:59:41.000+0000, LeadSource=Partnerships, Level__c=null, Lifetime_Experience_Bookings__c=12.0, Lifetime_Reservations__c=null, Lifetime_Value__c=null, MailingAddress={city=Peoria, country=United States, geocodeAccuracy=null, latitude=null, longitude=null, postalCode=85383, state=Arizona, street=75563 Farwell Drive}, MailingCity=Peoria, MailingCountry=United States, MailingGeocodeAccuracy=null, MailingLatitude=null, MailingLongitude=null, MailingPostalCode=85383, MailingState=Arizona, MailingStreet=75563 Farwell Drive, MasterRecordId=null, Maximum_Room_Cost__c=null, Membership_Number__c=10003177, Minimum_Room_Cost__c=null, MobilePhone=196-794-6794, Name=Nedi Heinsius, Next_Check_in_Date__c=null, OtherAddress=null, OtherCity=null, OtherCountry=null, OtherGeocodeAccuracy=null, OtherLatitude=null, OtherLongitude=null, OtherPhone=null, OtherPostalCode=null, OtherState=null, OtherStreet=null, OwnerId=005AU00000OrYkDYAV, Phone=null, PhotoUrl=/services/images/photo/003AU00001J7b4GYAR, Photo_URL__c=null, Preferred_Name__c=Nedi, Pronouns=null, ReportsToId=null, Salutation=null, SystemModstamp=2025-09-09T13:59:53.000+0000, Title=null}}\",\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Here are the contact details for Nedi Heinsius.\",\n \"metricExplainability\": \"The BOT RESPONSE provides detailed information about the contact associated with the provided email, but it includes excessive technical data that is not relevant to the user. It does not clearly state the name of the contact as Nedi Heinsius, which is the expected output format. Thus, it partially achieves the goal but lacks clarity and precision.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"PASS\",\n \"score\": 3,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer does not provide any contact details for the email address, only a list of fields and their values from the database. It does not provide any information that can be used to contact the person associated with the email address.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is not coherent at all. It is difficult to understand what the answer is trying to say, and it is riddled with grammar errors. The answer seems to be a JSON object with contact details, but it is not formatted in a way that is easy to read or understand.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"FAILURE\",\n \"score\": 2,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:46:34Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 2728,\n \"startTime\": \"2025-09-10T13:46:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:47:26Z\",\n \"generatedData\": {\n \"actionsSequence\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5']\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[{"function":{"name":"Get_Customer_From_Email_or_Membership_Number_179AU00000038U5","input":{"customerMembershipNumber":"123456"},"output":{"contactId":null,"contactRecord":null}},"executionLatency":231}]]\",\n \"outcome\": \"I couldn't find any contact details associated with the membership number 123456. Could you double-check the number or provide additional information?\",\n \"sessionId\": \"019933e1-6ff4-79cf-a606-a0affb7e8762\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"Can you find the contact details for the membership number 123456?\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 6,\n \"testResults\": [\n {\n \"actualValue\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5']\",\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"['Get_Customer_From_Email_or_Membership_Number']\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"I couldn't find any contact details associated with the membership number 123456. Could you double-check the number or provide additional information?\",\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Here are the contact details for Frayda Dowsing.\",\n \"metricExplainability\": \"The BOT RESPONSE does not achieve the goal of providing the contact details as outlined in the EXPECTED RESPONSE. Instead, it incorrectly states that no contact details were found and asks for further information, which is unnecessary since the membership number should already be sufficient to retrieve the details from the CRM database. Therefore, it fails to align with the expected outcome.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer does not provide any contact details, which is the main request. It only provides a suggestion to double-check the number or provide additional information, which does not fully address the request.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is easy to understand, and it does not contain any significant grammar errors. The answer is also relevant to the query and provides a clear response.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"PASS\",\n \"score\": 5,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 2136,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:47:36Z\",\n \"generatedData\": {\n \"actionsSequence\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Generate_Personalized_Schedule_EA_179AU00000038U5']\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[{"function":{"name":"Get_Customer_From_Email_or_Membership_Number_179AU00000038U5","input":{"customerEmail":"nediheinsius@example.com"},"output":{"contactId":"003AU00001J7b4GYAR","contactRecord":{"sObjectInfo":{"apiName":"Contact","label":"Contact"},"id":"003AU00001J7b4GYAR","data":{"AccountId":null,"AssistantName":null,"AssistantPhone":null,"Average_Room_Cost__c":null,"Birthdate":"2042-05-03","CleanStatus":"Pending","ContactSource":null,"CreatedById":"005AU00000OrYkDYAV","CreatedDate":"2025-09-09T13:59:41.000+0000","Department":null,"Description":null,"DoNotCall":false,"Email":"nediheinsius@example.com","EmailBouncedDate":null,"EmailBouncedReason":null,"External_Id__c":"10003177","Fax":null,"FirstName":"Nedi","GenderIdentity":null,"Guest_Type__c":"Business and Pleasure Travelers","HasOptedOutOfEmail":false,"HasOptedOutOfFax":false,"HomePhone":null,"Id":"003AU00001J7b4GYAR","IndividualId":null,"Interest1__c":"Fitness & Exercise","Interest2__c":"Nightlife & Entertainment","Interest3__c":"Nature & Eco Tours","IsDeleted":false,"IsEmailBounced":false,"Jigsaw":null,"JigsawContactId":null,"Languages__c":null,"LastActivityDate":null,"LastCURequestDate":null,"LastCUUpdateDate":null,"LastModifiedById":"005AU00000OrYkDYAV","LastModifiedDate":"2025-09-09T13:59:53.000+0000","LastName":"Heinsius","LastReferencedDate":"2025-09-09T13:59:41.000+0000","LastViewedDate":"2025-09-09T13:59:41.000+0000","LeadSource":"Partnerships","Level__c":null,"Lifetime_Experience_Bookings__c":12.0,"Lifetime_Reservations__c":null,"Lifetime_Value__c":null,"MailingAddress":{"city":"Peoria","country":"United States","geocodeAccuracy":null,"latitude":null,"longitude":null,"postalCode":"85383","state":"Arizona","street":"75563 Farwell Drive"},"MailingCity":"Peoria","MailingCountry":"United States","MailingGeocodeAccuracy":null,"MailingLatitude":null,"MailingLongitude":null,"MailingPostalCode":"85383","MailingState":"Arizona","MailingStreet":"75563 Farwell Drive","MasterRecordId":null,"Maximum_Room_Cost__c":null,"Membership_Number__c":"10003177","Minimum_Room_Cost__c":null,"MobilePhone":"196-794-6794","Name":"Nedi Heinsius","Next_Check_in_Date__c":null,"OtherAddress":null,"OtherCity":null,"OtherCountry":null,"OtherGeocodeAccuracy":null,"OtherLatitude":null,"OtherLongitude":null,"OtherPhone":null,"OtherPostalCode":null,"OtherState":null,"OtherStreet":null,"OwnerId":"005AU00000OrYkDYAV","Phone":null,"PhotoUrl":"/services/images/photo/003AU00001J7b4GYAR","Photo_URL__c":null,"Preferred_Name__c":"Nedi","Pronouns":null,"ReportsToId":null,"Salutation":null,"SystemModstamp":"2025-09-09T13:59:53.000+0000","Title":null}}}},"executionLatency":472},{"function":{"name":"Generate_Personalized_Schedule_EA_179AU00000038U5","input":{"Input:contactId":"003AU00001J7b4GYAR"},"output":{"promptResponse":"Hello, I am Philippe from the guest success team at Coral Cloud. I appreciate your interest in our r"}},"executionLatency":8462}]]\",\n \"outcome\": \"Here's the personalized schedule for Nedi Heinsius. Let me know if you'd like to book any of these activities!\\nHello, I am Philippe from the guest success team at Coral Cloud. I appreciate your interest in our resort activities. Here is a list of activities happening today that align with your interests: - Sunrise Mountain Yoga: 09:00 AM, Mountain Overlook, 6 hours - Aqua Fitness in Paradise: 09:00 AM, Resort Pool, 3 hours - Ocean Kayak Fitness Expedition: 09:00 AM, Coastal Waters, 6 hours - Rainforest Discovery Hike: 09:00 AM, Rainforest Reserve, 2 hours - Coastal Kayak Excursion: 09:00 AM, Coastal Waters, 1 hour - Live Music Beach Party: 09:00 AM, Resort Beach, 2 hours - Sunset Cocktail Cruise: 09:00 AM, Ocean Cruise, 1 hour - Outdoor Movie Night: 09:00 AM, Outdoor Cinema Area, 6 hours Given the overlapping times and the requirement for free time between activities, I suggest the following schedule: 1. Coastal Kayak Excursion: 09:00 AM - 10:00 AM 2. Free Time: 10:00 AM - 11:00 AM 3. Rainforest Discovery Hike: 11:00 AM - 01:00 PM 4. Free Time: 01:00 PM - 02:00 PM 5. Live Music Beach Party: 02:00 PM - 04:00 PM 6. Free Time: 04:00 PM - 05:00 PM 7. Sunset Cocktail Cruise: 05:00 PM - 06:00 PM Please reach out if you would like to book any of these activities. Thank you for your time.\",\n \"sessionId\": \"019933e1-701f-7837-ad0e-68f7997b92ba\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"Can you create a personalized schedule for the guest with email nediheinsius@example.com?\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 7,\n \"testResults\": [\n {\n \"actualValue\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Generate_Personalized_Schedule_EA_179AU00000038U5']\",\n \"endTime\": \"2025-09-10T13:47:37Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"['Get_Customer_From_Email_or_Membership_Number', 'Generate_Personalized_Schedule_EA']\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Here's the personalized schedule for Nedi Heinsius. Let me know if you'd like to book any of these activities!\\nHello, I am Philippe from the guest success team at Coral Cloud. I appreciate your interest in our resort activities. Here is a list of activities happening today that align with your interests: - Sunrise Mountain Yoga: 09:00 AM, Mountain Overlook, 6 hours - Aqua Fitness in Paradise: 09:00 AM, Resort Pool, 3 hours - Ocean Kayak Fitness Expedition: 09:00 AM, Coastal Waters, 6 hours - Rainforest Discovery Hike: 09:00 AM, Rainforest Reserve, 2 hours - Coastal Kayak Excursion: 09:00 AM, Coastal Waters, 1 hour - Live Music Beach Party: 09:00 AM, Resort Beach, 2 hours - Sunset Cocktail Cruise: 09:00 AM, Ocean Cruise, 1 hour - Outdoor Movie Night: 09:00 AM, Outdoor Cinema Area, 6 hours Given the overlapping times and the requirement for free time between activities, I suggest the following schedule: 1. Coastal Kayak Excursion: 09:00 AM - 10:00 AM 2. Free Time: 10:00 AM - 11:00 AM 3. Rainforest Discovery Hike: 11:00 AM - 01:00 PM 4. Free Time: 01:00 PM - 02:00 PM 5. Live Music Beach Party: 02:00 PM - 04:00 PM 6. Free Time: 04:00 PM - 05:00 PM 7. Sunset Cocktail Cruise: 05:00 PM - 06:00 PM Please reach out if you would like to book any of these activities. Thank you for your time.\",\n \"endTime\": \"2025-09-10T13:47:37Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Here is the personalized schedule for Nedi Heinsius.\",\n \"metricExplainability\": \"The BOT RESPONSE provides a personalized schedule as requested in the QUERY, but it contains excessive information beyond the expected response, making it less precise. The initial output should have simply confirmed the creation of the schedule without the detailed list of activities and free time suggestions.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:47:37Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:37Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer provides a detailed schedule with specific activities and times, but it does not explicitly mention the guest's email address nediheinsius@example.com or provide a personalized schedule for the guest. The answer also does not mention the resort name or the guest's name, which could be considered important information.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:37Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is generally understandable, but it contains some sections that are unclear, such as the overlapping times and the requirement for free time between activities. The grammar errors are minor and do not significantly impact readability.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"PASS\",\n \"score\": 3,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:37Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"PASS\",\n \"score\": 3,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:37Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 11834,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:47:41Z\",\n \"generatedData\": {\n \"actionsSequence\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Generate_Personalized_Schedule_EA_179AU00000038U5']\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[{"function":{"name":"Get_Customer_From_Email_or_Membership_Number_179AU00000038U5","input":{"customerMembershipNumber":"10008155"},"output":{"contactId":"003AU00001J7zDuYAJ","contactRecord":{"sObjectInfo":{"apiName":"Contact","label":"Contact"},"id":"003AU00001J7zDuYAJ","data":{"AccountId":null,"AssistantName":null,"AssistantPhone":null,"Average_Room_Cost__c":null,"Birthdate":"1978-11-10","CleanStatus":"Pending","ContactSource":null,"CreatedById":"005AU00000OrYkDYAV","CreatedDate":"2025-09-09T13:59:41.000+0000","Department":null,"Description":null,"DoNotCall":false,"Email":"sofiarodriguez@example.com","EmailBouncedDate":null,"EmailBouncedReason":null,"External_Id__c":"10008155","Fax":null,"FirstName":"Sofia","GenderIdentity":null,"Guest_Type__c":"Cultural Connoisseurs","HasOptedOutOfEmail":false,"HasOptedOutOfFax":false,"HomePhone":null,"Id":"003AU00001J7zDuYAJ","IndividualId":null,"Interest1__c":"Adventure Activities","Interest2__c":"Beaches & Snorkeling","Interest3__c":"Fitness & Exercise","IsDeleted":false,"IsEmailBounced":false,"Jigsaw":null,"JigsawContactId":null,"Languages__c":null,"LastActivityDate":null,"LastCURequestDate":null,"LastCUUpdateDate":null,"LastModifiedById":"005AU00000OrYkDYAV","LastModifiedDate":"2025-09-09T13:59:53.000+0000","LastName":"Rodriguez","LastReferencedDate":"2025-09-09T15:43:53.000+0000","LastViewedDate":"2025-09-09T15:43:53.000+0000","LeadSource":"Direct Mail","Level__c":null,"Lifetime_Experience_Bookings__c":10.0,"Lifetime_Reservations__c":null,"Lifetime_Value__c":null,"MailingAddress":{"city":"Minneapolis","country":"United States","geocodeAccuracy":null,"latitude":null,"longitude":null,"postalCode":"55428","state":"Minnesota","street":"3 6th Avenue"},"MailingCity":"Minneapolis","MailingCountry":"United States","MailingGeocodeAccuracy":null,"MailingLatitude":null,"MailingLongitude":null,"MailingPostalCode":"55428","MailingState":"Minnesota","MailingStreet":"3 6th Avenue","MasterRecordId":null,"Maximum_Room_Cost__c":null,"Membership_Number__c":"10008155","Minimum_Room_Cost__c":null,"MobilePhone":"612-350-2240","Name":"Sofia Rodriguez","Next_Check_in_Date__c":"2024-12-20","OtherAddress":null,"OtherCity":null,"OtherCountry":null,"OtherGeocodeAccuracy":null,"OtherLatitude":null,"OtherLongitude":null,"OtherPhone":null,"OtherPostalCode":null,"OtherState":null,"OtherStreet":null,"OwnerId":"005AU00000OrYkDYAV","Phone":null,"PhotoUrl":"/services/images/photo/003AU00001J7zDuYAJ","Photo_URL__c":"https://s3-us-west-2.amazonaws.com/dev-or-devrl-s3-bucket/sample-apps/coral-clouds/qswvurmhbo9w261ce","Preferred_Name__c":"Sofi","Pronouns":null,"ReportsToId":null,"Salutation":null,"SystemModstamp":"2025-09-09T13:59:53.000+0000","Title":null}}}},"executionLatency":199},{"function":{"name":"Generate_Personalized_Schedule_EA_179AU00000038U5","input":{"Input:contactId":"003AU00001J7zDuYAJ"},"output":{"promptResponse":"Hello, I am Philippe from the guest success team at Coral Cloud. I am pleased to present the list of"}},"executionLatency":13647}]]\",\n \"outcome\": \"Here's the personalized schedule for Sofia Rodriguez. Let me know if you'd like to book any of these activities!\\nHello, I am Philippe from the guest success team at Coral Cloud. I am pleased to present the list of resort activities happening today that match your interests: - Sunrise Mountain Yoga: 09:00 AM, Mountain Overlook, 6 hours - Aqua Fitness in Paradise: 09:00 AM, Resort Pool, 3 hours - Ocean Kayak Fitness Expedition: 09:00 AM, Coastal Waters, 6 hours - Tropical Snorkel Adventure: 09:00 AM, Coral Reef, 4 hours - Canyon Zip Line Excursion: 09:00 AM, Canyons & Forests, 3.5 hours - Off-Road Jungle Safari: 09:00 AM, Jungle Trails, 4 hours - White Water Rafting Rush: 09:00 AM, Rivers, 1 hour - Underground Cave Exploration: 09:00 AM, Subterranean Caves, 5 hours - Full Moon Beach Party: 09:00 AM, Beach, 2 hours - Surf's Up Lesson: 09:00 AM, Surfing Areas, 1 hour Given the overlapping schedules and the requirement for free time, I suggest the following schedule: 1. Sunrise Mountain Yoga: 09:00 AM - 03:00 PM 2. Free Time: 03:00 PM - 04:00 PM 3. Aqua Fitness in Paradise: 04:00 PM - 07:00 PM Please reach out if you would like to book any of these activities. Thank you for your time.\",\n \"sessionId\": \"019933e1-6fef-7140-a47b-f96f80fe9be1\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"Can you create a personalized schedule for customer with Membership Number\\n10008155?\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 8,\n \"testResults\": [\n {\n \"actualValue\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Generate_Personalized_Schedule_EA_179AU00000038U5']\",\n \"endTime\": \"2025-09-10T13:47:42Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"['Get_Customer_From_Email_or_Membership_Number', 'Generate_Personalized_Schedule_EA']\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Here's the personalized schedule for Sofia Rodriguez. Let me know if you'd like to book any of these activities!\\nHello, I am Philippe from the guest success team at Coral Cloud. I am pleased to present the list of resort activities happening today that match your interests: - Sunrise Mountain Yoga: 09:00 AM, Mountain Overlook, 6 hours - Aqua Fitness in Paradise: 09:00 AM, Resort Pool, 3 hours - Ocean Kayak Fitness Expedition: 09:00 AM, Coastal Waters, 6 hours - Tropical Snorkel Adventure: 09:00 AM, Coral Reef, 4 hours - Canyon Zip Line Excursion: 09:00 AM, Canyons & Forests, 3.5 hours - Off-Road Jungle Safari: 09:00 AM, Jungle Trails, 4 hours - White Water Rafting Rush: 09:00 AM, Rivers, 1 hour - Underground Cave Exploration: 09:00 AM, Subterranean Caves, 5 hours - Full Moon Beach Party: 09:00 AM, Beach, 2 hours - Surf's Up Lesson: 09:00 AM, Surfing Areas, 1 hour Given the overlapping schedules and the requirement for free time, I suggest the following schedule: 1. Sunrise Mountain Yoga: 09:00 AM - 03:00 PM 2. Free Time: 03:00 PM - 04:00 PM 3. Aqua Fitness in Paradise: 04:00 PM - 07:00 PM Please reach out if you would like to book any of these activities. Thank you for your time.\",\n \"endTime\": \"2025-09-10T13:47:42Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Here is your personalized schedule for today, Sofia Rodriguez.\",\n \"metricExplainability\": \"The BOT RESPONSE provides a personalized schedule but includes unnecessary details and activities that may not be relevant to the user. It also addresses the user as Sofia Rodriguez instead of using their actual name, which could lead to confusion. The response does not fully align with the expected outcome, which is a concise presentation of the schedule without extra information.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"PASS\",\n \"score\": 3,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:47:42Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:42Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer provides a detailed schedule with specific activities and times, but it does not include any information about the customer's membership number or how it relates to the schedule. The answer also does not provide any information about the customer's interests or preferences, which is a key part of creating a personalized schedule.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:42Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is generally understandable, but it contains some sections that are unclear, such as the mention of 'free time' and the specific activities listed. The grammar is also correct, but the answer could be improved by providing more context or explanation for the schedule.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"PASS\",\n \"score\": 3,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:42Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"FAILURE\",\n \"score\": 2,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:42Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 17047,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:48:29Z\",\n \"generatedData\": {\n \"actionsSequence\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5']\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[{"function":{"name":"Get_Customer_From_Email_or_Membership_Number_179AU00000038U5","input":{"customerEmail":"nediheinsius@example.com"},"output":{"contactId":"003AU00001J7b4GYAR","contactRecord":{"sObjectInfo":{"apiName":"Contact","label":"Contact"},"id":"003AU00001J7b4GYAR","data":{"AccountId":null,"AssistantName":null,"AssistantPhone":null,"Average_Room_Cost__c":null,"Birthdate":"2042-05-03","CleanStatus":"Pending","ContactSource":null,"CreatedById":"005AU00000OrYkDYAV","CreatedDate":"2025-09-09T13:59:41.000+0000","Department":null,"Description":null,"DoNotCall":false,"Email":"nediheinsius@example.com","EmailBouncedDate":null,"EmailBouncedReason":null,"External_Id__c":"10003177","Fax":null,"FirstName":"Nedi","GenderIdentity":null,"Guest_Type__c":"Business and Pleasure Travelers","HasOptedOutOfEmail":false,"HasOptedOutOfFax":false,"HomePhone":null,"Id":"003AU00001J7b4GYAR","IndividualId":null,"Interest1__c":"Fitness & Exercise","Interest2__c":"Nightlife & Entertainment","Interest3__c":"Nature & Eco Tours","IsDeleted":false,"IsEmailBounced":false,"Jigsaw":null,"JigsawContactId":null,"Languages__c":null,"LastActivityDate":null,"LastCURequestDate":null,"LastCUUpdateDate":null,"LastModifiedById":"005AU00000OrYkDYAV","LastModifiedDate":"2025-09-09T13:59:53.000+0000","LastName":"Heinsius","LastReferencedDate":"2025-09-09T13:59:41.000+0000","LastViewedDate":"2025-09-09T13:59:41.000+0000","LeadSource":"Partnerships","Level__c":null,"Lifetime_Experience_Bookings__c":12.0,"Lifetime_Reservations__c":null,"Lifetime_Value__c":null,"MailingAddress":{"city":"Peoria","country":"United States","geocodeAccuracy":null,"latitude":null,"longitude":null,"postalCode":"85383","state":"Arizona","street":"75563 Farwell Drive"},"MailingCity":"Peoria","MailingCountry":"United States","MailingGeocodeAccuracy":null,"MailingLatitude":null,"MailingLongitude":null,"MailingPostalCode":"85383","MailingState":"Arizona","MailingStreet":"75563 Farwell Drive","MasterRecordId":null,"Maximum_Room_Cost__c":null,"Membership_Number__c":"10003177","Minimum_Room_Cost__c":null,"MobilePhone":"196-794-6794","Name":"Nedi Heinsius","Next_Check_in_Date__c":null,"OtherAddress":null,"OtherCity":null,"OtherCountry":null,"OtherGeocodeAccuracy":null,"OtherLatitude":null,"OtherLongitude":null,"OtherPhone":null,"OtherPostalCode":null,"OtherState":null,"OtherStreet":null,"OwnerId":"005AU00000OrYkDYAV","Phone":null,"PhotoUrl":"/services/images/photo/003AU00001J7b4GYAR","Photo_URL__c":null,"Preferred_Name__c":"Nedi","Pronouns":null,"ReportsToId":null,"Salutation":null,"SystemModstamp":"2025-09-09T13:59:53.000+0000","Title":null}}}},"executionLatency":189}]]\",\n \"outcome\": \"How much resort credit would you like to issue to Nedi Heinsius?\",\n \"sessionId\": \"019933e2-5a89-7002-a35b-12a7b351a7c2\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"I need a resort credit issued to my account. My email is nediheinsius@example.com.\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 9,\n \"testResults\": [\n {\n \"actualValue\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5']\",\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"['Get_Customer_From_Email_or_Membership_Number']\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"How much resort credit would you like to issue to Nedi Heinsius?\",\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Please provide the amount for the resort credit.\",\n \"metricExplainability\": \"The BOT RESPONSE correctly prompts the user for the amount of resort credit, which aligns with the EXPECTED RESPONSE. However, it mistakenly includes the placeholder Nedi Heinsius instead of simply asking for the amount directly, which introduces unnecessary ambiguity. Overall, it is clear and aims to collect the required information.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer does not provide any information about the resort credit, such as the amount or the account it will be issued to, which are the main points of the request.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is a question and does not provide any resort credit, making it difficult to understand what the answer is trying to say. It also lacks any context or information about the resort credit.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"PASS\",\n \"score\": 3,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 3777,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:48:29Z\",\n \"generatedData\": {\n \"actionsSequence\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Issue_Resort_Credit_179AU00000038U5']\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[{"function":{"name":"Get_Customer_From_Email_or_Membership_Number_179AU00000038U5","input":{"customerEmail":"fraydadowsing@example.com"},"output":{"contactId":"003AU00001J7b4FYAR","contactRecord":{"sObjectInfo":{"apiName":"Contact","label":"Contact"},"id":"003AU00001J7b4FYAR","data":{"AccountId":null,"AssistantName":null,"AssistantPhone":null,"Average_Room_Cost__c":null,"Birthdate":"1994-11-19","CleanStatus":"Pending","ContactSource":null,"CreatedById":"005AU00000OrYkDYAV","CreatedDate":"2025-09-09T13:59:41.000+0000","Department":null,"Description":null,"DoNotCall":false,"Email":"fraydadowsing@example.com","EmailBouncedDate":null,"EmailBouncedReason":null,"External_Id__c":"10008756","Fax":null,"FirstName":"Frayda","GenderIdentity":null,"Guest_Type__c":"Romance Retreaters","HasOptedOutOfEmail":false,"HasOptedOutOfFax":false,"HomePhone":null,"Id":"003AU00001J7b4FYAR","IndividualId":null,"Interest1__c":"Dining Experiences","Interest2__c":"Cultural Tours & Workshops","Interest3__c":"Family & Kids' Activities","IsDeleted":false,"IsEmailBounced":false,"Jigsaw":null,"JigsawContactId":null,"Languages__c":null,"LastActivityDate":null,"LastCURequestDate":null,"LastCUUpdateDate":null,"LastModifiedById":"005AU00000OrYkDYAV","LastModifiedDate":"2025-09-09T13:59:53.000+0000","LastName":"Dowsing","LastReferencedDate":"2025-09-09T14:19:58.000+0000","LastViewedDate":"2025-09-09T14:19:58.000+0000","LeadSource":"Online Travel Agent","Level__c":null,"Lifetime_Experience_Bookings__c":17.0,"Lifetime_Reservations__c":null,"Lifetime_Value__c":null,"MailingAddress":{"city":"Honolulu","country":"United States","geocodeAccuracy":null,"latitude":null,"longitude":null,"postalCode":"96815","state":"Hawaii","street":"94046 Grasskamp Junction"},"MailingCity":"Honolulu","MailingCountry":"United States","MailingGeocodeAccuracy":null,"MailingLatitude":null,"MailingLongitude":null,"MailingPostalCode":"96815","MailingState":"Hawaii","MailingStreet":"94046 Grasskamp Junction","MasterRecordId":null,"Maximum_Room_Cost__c":null,"Membership_Number__c":"10008756","Minimum_Room_Cost__c":null,"MobilePhone":"707-490-8673","Name":"Frayda Dowsing","Next_Check_in_Date__c":null,"OtherAddress":null,"OtherCity":null,"OtherCountry":null,"OtherGeocodeAccuracy":null,"OtherLatitude":null,"OtherLongitude":null,"OtherPhone":null,"OtherPostalCode":null,"OtherState":null,"OtherStreet":null,"OwnerId":"005AU00000OrYkDYAV","Phone":null,"PhotoUrl":"/services/images/photo/003AU00001J7b4FYAR","Photo_URL__c":null,"Preferred_Name__c":"Frayda","Pronouns":null,"ReportsToId":null,"Salutation":null,"SystemModstamp":"2025-09-09T13:59:53.000+0000","Title":null}}}},"executionLatency":227},{"function":{"name":"Issue_Resort_Credit_179AU00000038U5","input":{"amount":"100","contactid":"003AU00001J7b4FYAR"},"output":{"creditId":"a01AU00000xd7sUYAQ"}},"executionLatency":243}]]\",\n \"outcome\": \"The $100 resort credit has been successfully issued to Frayda Dowsing. Let me know if there's anything else I can assist with!\\na01AU00000xd7sUYAQ\",\n \"sessionId\": \"019933e2-5a5f-7622-8dba-904115dfc0a4\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"Please issue a $100 resort credit to the contact with email fraydadowsing@example.com.\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 10,\n \"testResults\": [\n {\n \"actualValue\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Issue_Resort_Credit_179AU00000038U5']\",\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"['Get_Customer_From_Email_or_Membership_Number', 'Issue_Resort_Credit']\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"The $100 resort credit has been successfully issued to Frayda Dowsing. Let me know if there's anything else I can assist with!\\na01AU00000xd7sUYAQ\",\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"A $100 resort credit has been issued to Frayda Dowsing.\",\n \"metricExplainability\": \"The BOT RESPONSE successfully confirms the issuance of the $100 resort credit to Frayda Dowsing, which fully aligns with the EXPECTED RESPONSE. However, it includes an unnecessary additional phrase asking if further assistance is needed, which is not part of the EXPECTED RESPONSE.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer does not provide the email address of the contact to whom the resort credit was issued, which is a crucial piece of information. The answer also includes an irrelevant code 'a01AU00000xd7sUYAQ' which is not part of the context.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is difficult to understand, and it contains multiple grammar errors that affect clarity. The phrase 'Let me know if there's anything else I can assist with!' seems out of place and does not contribute to the coherence of the answer.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"PASS\",\n \"score\": 5,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:30Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 3519,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:47:30Z\",\n \"generatedData\": {\n \"actionsSequence\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Issue_Resort_Credit_179AU00000038U5']\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[{"function":{"name":"Get_Customer_From_Email_or_Membership_Number_179AU00000038U5","input":{"customerMembershipNumber":"10008155"},"output":{"contactId":"003AU00001J7zDuYAJ","contactRecord":{"sObjectInfo":{"apiName":"Contact","label":"Contact"},"id":"003AU00001J7zDuYAJ","data":{"AccountId":null,"AssistantName":null,"AssistantPhone":null,"Average_Room_Cost__c":null,"Birthdate":"1978-11-10","CleanStatus":"Pending","ContactSource":null,"CreatedById":"005AU00000OrYkDYAV","CreatedDate":"2025-09-09T13:59:41.000+0000","Department":null,"Description":null,"DoNotCall":false,"Email":"sofiarodriguez@example.com","EmailBouncedDate":null,"EmailBouncedReason":null,"External_Id__c":"10008155","Fax":null,"FirstName":"Sofia","GenderIdentity":null,"Guest_Type__c":"Cultural Connoisseurs","HasOptedOutOfEmail":false,"HasOptedOutOfFax":false,"HomePhone":null,"Id":"003AU00001J7zDuYAJ","IndividualId":null,"Interest1__c":"Adventure Activities","Interest2__c":"Beaches & Snorkeling","Interest3__c":"Fitness & Exercise","IsDeleted":false,"IsEmailBounced":false,"Jigsaw":null,"JigsawContactId":null,"Languages__c":null,"LastActivityDate":null,"LastCURequestDate":null,"LastCUUpdateDate":null,"LastModifiedById":"005AU00000OrYkDYAV","LastModifiedDate":"2025-09-09T13:59:53.000+0000","LastName":"Rodriguez","LastReferencedDate":"2025-09-09T15:43:53.000+0000","LastViewedDate":"2025-09-09T15:43:53.000+0000","LeadSource":"Direct Mail","Level__c":null,"Lifetime_Experience_Bookings__c":10.0,"Lifetime_Reservations__c":null,"Lifetime_Value__c":null,"MailingAddress":{"city":"Minneapolis","country":"United States","geocodeAccuracy":null,"latitude":null,"longitude":null,"postalCode":"55428","state":"Minnesota","street":"3 6th Avenue"},"MailingCity":"Minneapolis","MailingCountry":"United States","MailingGeocodeAccuracy":null,"MailingLatitude":null,"MailingLongitude":null,"MailingPostalCode":"55428","MailingState":"Minnesota","MailingStreet":"3 6th Avenue","MasterRecordId":null,"Maximum_Room_Cost__c":null,"Membership_Number__c":"10008155","Minimum_Room_Cost__c":null,"MobilePhone":"612-350-2240","Name":"Sofia Rodriguez","Next_Check_in_Date__c":"2024-12-20","OtherAddress":null,"OtherCity":null,"OtherCountry":null,"OtherGeocodeAccuracy":null,"OtherLatitude":null,"OtherLongitude":null,"OtherPhone":null,"OtherPostalCode":null,"OtherState":null,"OtherStreet":null,"OwnerId":"005AU00000OrYkDYAV","Phone":null,"PhotoUrl":"/services/images/photo/003AU00001J7zDuYAJ","Photo_URL__c":"https://s3-us-west-2.amazonaws.com/dev-or-devrl-s3-bucket/sample-apps/coral-clouds/qswvurmhbo9w261ce","Preferred_Name__c":"Sofi","Pronouns":null,"ReportsToId":null,"Salutation":null,"SystemModstamp":"2025-09-09T13:59:53.000+0000","Title":null}}}},"executionLatency":196},{"function":{"name":"Issue_Resort_Credit_179AU00000038U5","input":{"amount":"100","contactid":"003AU00001J7zDuYAJ"},"output":{"creditId":"a01AU00000xbStAYAU"}},"executionLatency":254}]]\",\n \"outcome\": \"The $100 resort credit has been successfully issued to Sofia Rodriguez. Let me know if there's anything else I can assist you with!\\na01AU00000xbStAYAU\",\n \"sessionId\": \"019933e1-7010-7b01-98d2-00689ea0ae63\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"I need a $100 resort credit issued to the customer with Membership Number\\n10008155?\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 11,\n \"testResults\": [\n {\n \"actualValue\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Issue_Resort_Credit_179AU00000038U5']\",\n \"endTime\": \"2025-09-10T13:47:31Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"['Get_Customer_From_Email_or_Membership_Number', 'Issue_Resort_Credit']\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"The $100 resort credit has been successfully issued to Sofia Rodriguez. Let me know if there's anything else I can assist you with!\\na01AU00000xbStAYAU\",\n \"endTime\": \"2025-09-10T13:47:31Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"A $100 resort credit has been issued to your account, Sofia Rodriguez.\",\n \"metricExplainability\": \"The BOT RESPONSE confirms the issuance of the resort credit but includes an irrelevant identifier (a01AU00000xbStAYAU) that is not part of the EXPECTED RESPONSE. It does not clearly state the membership number or provide the user's name, which is implied in the QUERY. Therefore, it partially aligns with the EXPECTED RESPONSE but includes unnecessary information.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"PASS\",\n \"score\": 3,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:47:31Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:31Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer does not provide the required resort credit to the customer with Membership Number 10008155, and instead provides a generic message and an unknown code. The answer is very incomplete as it misses the crucial information about the resort credit.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:31Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is generally understandable, but the second sentence is unclear and contains a grammar error. The phrase 'Let me know if there's anything else I can assist you with!' is not directly related to the main task of issuing a resort credit.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"PASS\",\n \"score\": 3,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:31Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"PASS\",\n \"score\": 5,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:31Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 3803,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"generatedData\": {\n \"actionsSequence\": \"[]\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[]]\",\n \"outcome\": \"Could you provide the list of contacts you'd like to issue the $50 resort credits to? This can include their names, emails, or membership numbers.\",\n \"sessionId\": \"019933e1-701c-77b2-bcba-b8a3b8e1dbb2\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"I need to issue $50 resort credits to multiple contacts.\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 12,\n \"testResults\": [\n {\n \"actualValue\": \"[]\",\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"[]\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Could you provide the list of contacts you'd like to issue the $50 resort credits to? This can include their names, emails, or membership numbers.\",\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Please provide the emails or contact IDs of the contacts to issue the credits.\",\n \"metricExplainability\": \"The BOT RESPONSE correctly prompts the user for the necessary information to achieve the goal of issuing resort credits. However, it slightly deviates from the EXPECTED RESPONSE by including names and membership numbers as options, which are not mentioned in the EXPECTED RESPONSE. This makes it slightly ambiguous, but it still aligns with the overall goal.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is very incomplete as it does not provide the resort credits to the contacts, instead it asks for the list of contacts.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"FAILURE\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is easy to understand, and the language is clear. There are no significant grammar errors that affect readability.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"PASS\",\n \"score\": 5,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:47:27Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 2158,\n \"startTime\": \"2025-09-10T13:47:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n },\n {\n \"endTime\": \"2025-09-10T13:48:29Z\",\n \"generatedData\": {\n \"actionsSequence\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Issue_Bulk_Resort_Credits_179AU00000038U5']\",\n \"citations\": \"[ ]\",\n \"invokedActions\": \"[[{"function":{"name":"Get_Customer_From_Email_or_Membership_Number_179AU00000038U5","input":{"customerEmail":"nediheinsius@example.com"},"output":{"contactId":"003AU00001J7b4GYAR","contactRecord":{"sObjectInfo":{"apiName":"Contact","label":"Contact"},"id":"003AU00001J7b4GYAR","data":{"AccountId":null,"AssistantName":null,"AssistantPhone":null,"Average_Room_Cost__c":null,"Birthdate":"2042-05-03","CleanStatus":"Pending","ContactSource":null,"CreatedById":"005AU00000OrYkDYAV","CreatedDate":"2025-09-09T13:59:41.000+0000","Department":null,"Description":null,"DoNotCall":false,"Email":"nediheinsius@example.com","EmailBouncedDate":null,"EmailBouncedReason":null,"External_Id__c":"10003177","Fax":null,"FirstName":"Nedi","GenderIdentity":null,"Guest_Type__c":"Business and Pleasure Travelers","HasOptedOutOfEmail":false,"HasOptedOutOfFax":false,"HomePhone":null,"Id":"003AU00001J7b4GYAR","IndividualId":null,"Interest1__c":"Fitness & Exercise","Interest2__c":"Nightlife & Entertainment","Interest3__c":"Nature & Eco Tours","IsDeleted":false,"IsEmailBounced":false,"Jigsaw":null,"JigsawContactId":null,"Languages__c":null,"LastActivityDate":null,"LastCURequestDate":null,"LastCUUpdateDate":null,"LastModifiedById":"005AU00000OrYkDYAV","LastModifiedDate":"2025-09-09T13:59:53.000+0000","LastName":"Heinsius","LastReferencedDate":"2025-09-09T13:59:41.000+0000","LastViewedDate":"2025-09-09T13:59:41.000+0000","LeadSource":"Partnerships","Level__c":null,"Lifetime_Experience_Bookings__c":12.0,"Lifetime_Reservations__c":null,"Lifetime_Value__c":null,"MailingAddress":{"city":"Peoria","country":"United States","geocodeAccuracy":null,"latitude":null,"longitude":null,"postalCode":"85383","state":"Arizona","street":"75563 Farwell Drive"},"MailingCity":"Peoria","MailingCountry":"United States","MailingGeocodeAccuracy":null,"MailingLatitude":null,"MailingLongitude":null,"MailingPostalCode":"85383","MailingState":"Arizona","MailingStreet":"75563 Farwell Drive","MasterRecordId":null,"Maximum_Room_Cost__c":null,"Membership_Number__c":"10003177","Minimum_Room_Cost__c":null,"MobilePhone":"196-794-6794","Name":"Nedi Heinsius","Next_Check_in_Date__c":null,"OtherAddress":null,"OtherCity":null,"OtherCountry":null,"OtherGeocodeAccuracy":null,"OtherLatitude":null,"OtherLongitude":null,"OtherPhone":null,"OtherPostalCode":null,"OtherState":null,"OtherStreet":null,"OwnerId":"005AU00000OrYkDYAV","Phone":null,"PhotoUrl":"/services/images/photo/003AU00001J7b4GYAR","Photo_URL__c":null,"Preferred_Name__c":"Nedi","Pronouns":null,"ReportsToId":null,"Salutation":null,"SystemModstamp":"2025-09-09T13:59:53.000+0000","Title":null}}}},"executionLatency":208},{"function":{"name":"Get_Customer_From_Email_or_Membership_Number_179AU00000038U5","input":{"customerEmail":"fraydadowsing@example.com"},"output":{"contactId":"003AU00001J7b4FYAR","contactRecord":{"sObjectInfo":{"apiName":"Contact","label":"Contact"},"id":"003AU00001J7b4FYAR","data":{"AccountId":null,"AssistantName":null,"AssistantPhone":null,"Average_Room_Cost__c":null,"Birthdate":"1994-11-19","CleanStatus":"Pending","ContactSource":null,"CreatedById":"005AU00000OrYkDYAV","CreatedDate":"2025-09-09T13:59:41.000+0000","Department":null,"Description":null,"DoNotCall":false,"Email":"fraydadowsing@example.com","EmailBouncedDate":null,"EmailBouncedReason":null,"External_Id__c":"10008756","Fax":null,"FirstName":"Frayda","GenderIdentity":null,"Guest_Type__c":"Romance Retreaters","HasOptedOutOfEmail":false,"HasOptedOutOfFax":false,"HomePhone":null,"Id":"003AU00001J7b4FYAR","IndividualId":null,"Interest1__c":"Dining Experiences","Interest2__c":"Cultural Tours & Workshops","Interest3__c":"Family & Kids' Activities","IsDeleted":false,"IsEmailBounced":false,"Jigsaw":null,"JigsawContactId":null,"Languages__c":null,"LastActivityDate":null,"LastCURequestDate":null,"LastCUUpdateDate":null,"LastModifiedById":"005AU00000OrYkDYAV","LastModifiedDate":"2025-09-09T13:59:53.000+0000","LastName":"Dowsing","LastReferencedDate":"2025-09-09T14:19:58.000+0000","LastViewedDate":"2025-09-09T14:19:58.000+0000","LeadSource":"Online Travel Agent","Level__c":null,"Lifetime_Experience_Bookings__c":17.0,"Lifetime_Reservations__c":null,"Lifetime_Value__c":null,"MailingAddress":{"city":"Honolulu","country":"United States","geocodeAccuracy":null,"latitude":null,"longitude":null,"postalCode":"96815","state":"Hawaii","street":"94046 Grasskamp Junction"},"MailingCity":"Honolulu","MailingCountry":"United States","MailingGeocodeAccuracy":null,"MailingLatitude":null,"MailingLongitude":null,"MailingPostalCode":"96815","MailingState":"Hawaii","MailingStreet":"94046 Grasskamp Junction","MasterRecordId":null,"Maximum_Room_Cost__c":null,"Membership_Number__c":"10008756","Minimum_Room_Cost__c":null,"MobilePhone":"707-490-8673","Name":"Frayda Dowsing","Next_Check_in_Date__c":null,"OtherAddress":null,"OtherCity":null,"OtherCountry":null,"OtherGeocodeAccuracy":null,"OtherLatitude":null,"OtherLongitude":null,"OtherPhone":null,"OtherPostalCode":null,"OtherState":null,"OtherStreet":null,"OwnerId":"005AU00000OrYkDYAV","Phone":null,"PhotoUrl":"/services/images/photo/003AU00001J7b4FYAR","Photo_URL__c":null,"Preferred_Name__c":"Frayda","Pronouns":null,"ReportsToId":null,"Salutation":null,"SystemModstamp":"2025-09-09T13:59:53.000+0000","Title":null}}}},"executionLatency":217},{"function":{"name":"Issue_Bulk_Resort_Credits_179AU00000038U5","input":{"amount":"50","contactRecords":"[{\"sObjectInfo\":{\"apiName\":\"Contact\"},\"id\":\"003AU00001J7b4GYAR\",\"data\":{\"Id\":\"003AU00001J7b4GYAR\"}},{\"sObjectInfo\":{\"apiName\":\"Contact\"},\"id\":\"003AU00001J7b4FYAR\",\"data\":{\"Id\":\"003AU00001J7b4FYAR\"}}]"},"output":{"message":"Issued $50 resort credit to 2 customers."}},"executionLatency":321}]]\",\n \"outcome\": \"The $50 resort credits have been successfully issued to both contacts. Let me know if there's anything else you need!\\nIssued $50 resort credit to 2 customers.\",\n \"sessionId\": \"019933e2-5a71-7cbe-b8b0-002b6f876902\",\n \"topic\": \"Customer_Service_Assistant_16jAU0000003zGf\"\n },\n \"inputs\": {\n \"contextVariables\": {},\n \"conversationHistory\": [],\n \"utterance\": \"I need to issue $50 resort credits to two contacts. Their emails are nediheinsius@example.com and fraydadowsing@example.com.\"\n },\n \"startTime\": \"2025-09-10T13:46:14Z\",\n \"status\": \"COMPLETED\",\n \"testNumber\": 13,\n \"testResults\": [\n {\n \"actualValue\": \"['Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Get_Customer_From_Email_or_Membership_Number_179AU00000038U5', 'Issue_Bulk_Resort_Credits_179AU00000038U5']\",\n \"endTime\": \"2025-09-10T13:48:31Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"['Get_Customer_From_Email_or_Membership_Number', 'Get_Customer_From_Email_or_Membership_Number', 'Issue_Bulk_Resort_Credits']\",\n \"metricLabel\": \"actions_assertion\",\n \"name\": \"actions_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"The $50 resort credits have been successfully issued to both contacts. Let me know if there's anything else you need!\\nIssued $50 resort credit to 2 customers.\",\n \"endTime\": \"2025-09-10T13:48:31Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Bulk resort credits of $50 have been issued to the specified contacts.\",\n \"metricExplainability\": \"BOT RESPONSE accurately confirms the issuance of $50 resort credits to the specified contacts, aligning well with the EXPECTED RESPONSE. It is clear and precise, providing the necessary information without irrelevant details.\",\n \"metricLabel\": \"output_validation\",\n \"name\": \"output_validation\",\n \"result\": \"PASS\",\n \"score\": 5,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"actualValue\": \"Customer_Service_Assistant_16jAU0000003zGf\",\n \"endTime\": \"2025-09-10T13:48:31Z\",\n \"errorCode\": 0,\n \"expectedValue\": \"Customer_Service_Assistant\",\n \"metricLabel\": \"topic_assertion\",\n \"name\": \"topic_assertion\",\n \"result\": \"PASS\",\n \"score\": 1,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:31Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer provides the correct information about the resort credits being issued to two contacts, and it also includes additional information about the process, which is not requested. However, it does not provide any details about the specific emails of the contacts, which is requested in the context.\",\n \"metricLabel\": \"completeness\",\n \"name\": \"completeness\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:31Z\",\n \"errorCode\": 0,\n \"metricExplainability\": \"The answer is easy to understand, free of significant grammar errors, and flows well when read by itself. The answer is concise and clear, making it easy to understand the outcome of the task.\",\n \"metricLabel\": \"coherence\",\n \"name\": \"coherence\",\n \"result\": \"PASS\",\n \"score\": 4,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:31Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"conciseness\",\n \"name\": \"conciseness\",\n \"result\": \"PASS\",\n \"score\": 3,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n },\n {\n \"endTime\": \"2025-09-10T13:48:31Z\",\n \"errorCode\": 0,\n \"metricLabel\": \"output_latency_milliseconds\",\n \"name\": \"output_latency_milliseconds\",\n \"score\": 4851,\n \"startTime\": \"2025-09-10T13:48:16Z\",\n \"status\": \"COMPLETED\"\n }\n ]\n }\n ]\n}" } ] } ] }, { "name": "Messaging", "item": [ { "name": "Get conversation entries", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/conversation/:conversationIdentifier/entries", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "conversation", ":conversationIdentifier", "entries" ], "variable": [ { "key": "conversationIdentifier", "value": "", "description": "Conversation identifier UUID" } ] }, "description": "Gets in-app messaging conversation entries.\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_conversation_entries.htm" }, "response": [ { "name": "Get conversation entries", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/connect/conversation/:conversationIdentifier/entries", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "connect", "conversation", ":conversationIdentifier", "entries" ], "variable": [ { "key": "conversationIdentifier", "value": "bf94a5f1-5210-4227-b67b-125a994656ca" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Fri, 10 Jan 2025 11:40:26 GMT" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Transfer-Encoding", "value": "chunked" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Sforce-Limit-Info", "value": "api-usage=246/15000" }, { "key": "Strict-Transport-Security", "value": "max-age=63072000; includeSubDomains" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "Server", "value": "sfdcedge" }, { "key": "X-SFDC-Request-Id", "value": "5a8f2802ad688ae208710a5df1950663" }, { "key": "X-Request-Id", "value": "5a8f2802ad688ae208710a5df1950663" }, { "key": "X-SFDC-Edge-Cache", "value": "MISS" } ], "cookie": [], "body": "{\n \"conversationEntries\": [\n {\n \"clientDuration\": 0,\n \"clientTimestamp\": 1736508089610,\n \"identifier\": \"06a1182e-d932-4178-9864-6de5b7b3d3fd\",\n \"messageText\": \"The Canyon Zip Line Excursion is an exhilarating adventure where you can soar over deep canyons and lush forest canopies. Here are some details:\\n\\n- Description: Soar over deep canyons and lush forest canopies on our thrilling zip line tour.\\n- Activity Level: High\\n- Type: Adventure Activities\\n\\nWould you like to know the available sessions for this excursion? If so, please provide the date you're interested in.\",\n \"relatedRecords\": [],\n \"sender\": {\n \"appType\": \"chatbot\",\n \"role\": \"Chatbot\",\n \"subject\": \"0XxKj000000xpJh\"\n },\n \"serverReceivedTimestamp\": 1736508089657\n },\n {\n \"clientDuration\": 0,\n \"clientTimestamp\": 1736508081161,\n \"identifier\": \"414e8b7b-af09-4349-beee-79806657495c\",\n \"messageText\": \"sofiarodriguez@example.com and 10008155\",\n \"relatedRecords\": [\n \"0MwKj000007sdiM\"\n ],\n \"sender\": {\n \"appType\": \"iamessage\",\n \"role\": \"EndUser\",\n \"subject\": \"v2/iamessage/UNAUTH/NA/uid:cee38146-34f1-41a2-a96c-a5c4c9b8b62b\"\n },\n \"serverReceivedTimestamp\": 1736508081203\n },\n {\n \"clientDuration\": 0,\n \"clientTimestamp\": 1736508041619,\n \"identifier\": \"981246f2-7be4-4fa4-a8ea-2bb134c7f6ff\",\n \"messageText\": \"Could you please provide your email address and membership number so I can look up your details and get the information for you?\",\n \"relatedRecords\": [],\n \"sender\": {\n \"appType\": \"chatbot\",\n \"role\": \"Chatbot\",\n \"subject\": \"0XxKj000000xpJh\"\n },\n \"serverReceivedTimestamp\": 1736508041627\n },\n {\n \"clientDuration\": 0,\n \"clientTimestamp\": 1736508034543,\n \"identifier\": \"7db791fe-1f23-46d7-b685-7ad7b3f56f9d\",\n \"messageText\": \"show me more information about the canyon zip line excursion\",\n \"relatedRecords\": [\n \"0MwKj000007sdiM\"\n ],\n \"sender\": {\n \"appType\": \"iamessage\",\n \"role\": \"EndUser\",\n \"subject\": \"v2/iamessage/UNAUTH/NA/uid:cee38146-34f1-41a2-a96c-a5c4c9b8b62b\"\n },\n \"serverReceivedTimestamp\": 1736508034755\n },\n {\n \"clientDuration\": 0,\n \"clientTimestamp\": 1736508015523,\n \"identifier\": \"e9762707-0b3c-4656-8b91-9f10d04aa313\",\n \"messageText\": \"Hi, I'm an AI service assistant. How can I help you?\",\n \"relatedRecords\": [],\n \"sender\": {\n \"appType\": \"chatbot\",\n \"role\": \"Chatbot\",\n \"subject\": \"0XxKj000000xpJh\"\n },\n \"serverReceivedTimestamp\": 1736508015579\n }\n ]\n}" } ] } ] } ], "description": "Integrate mobile apps, intranet sites, and third-party web applications with Salesforce using Connect REST API. Responses are localized, structured for presentation, and can be filtered to contain only what the app needs.\n\nConnect REST API provides programmatic access to B2B Commerce, CMS managed content, Experience Cloud sites, files, notifications, topics, and more. Use Connect REST API to display Chatter feeds, users, and groups, especially in mobile applications.\n\n📚 [Connect REST API Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm)" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "grant_type", "value": "implicit", "type": "string" }, { "key": "scope", "value": "api", "type": "string" }, { "key": "addTokenTo", "value": "header", "type": "string" }, { "key": "client_authentication", "value": "body", "type": "string" }, { "key": "password", "value": "{{password}}", "type": "string" }, { "key": "username", "value": "{{username}}", "type": "string" }, { "key": "challengeAlgorithm", "value": "S256", "type": "string" }, { "key": "clientSecret", "value": "{{clientSecret}}", "type": "string" }, { "key": "clientId", "value": "{{clientId}}", "type": "string" }, { "key": "accessTokenUrl", "value": "{{url}}{{site}}/services/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "{{url}}{{site}}/services/oauth2/authorize", "type": "string" }, { "key": "tokenName", "value": "access_token", "type": "string" }, { "key": "useBrowser", "value": true, "type": "boolean" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "requests": {}, "exec": [ "// Specifying Postman as the client for Salesforce logs ", "pm.request.headers.add({key: 'Sforce-Call-Options', value: 'client=postman' });", "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "requests": {}, "exec": [ "" ] } } ], "variable": [ { "key": "url", "value": "https://login.salesforce.com" }, { "key": "version", "value": "64.0" }, { "key": "username", "value": "" }, { "key": "password", "value": "" }, { "key": "secretToken", "value": "" }, { "key": "clientId", "value": "{{vault:salesforce-consumer-key}}" }, { "key": "clientSecret", "value": "" }, { "key": "redirectUrl", "value": "" }, { "key": "initAccessToken", "value": "" }, { "key": "site", "value": "" }, { "key": "_accessToken", "value": "" }, { "key": "_endpoint", "value": "" }, { "key": "_userId", "value": "" }, { "key": "_appId", "value": "" }, { "key": "_consumerId", "value": "" }, { "key": "_tokenId", "value": "" }, { "key": "_orgId", "value": "" }, { "key": "_jobId", "value": "" }, { "key": "webstoreId", "value": "" }, { "key": "_deviceCode", "value": "" } ] }