{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"37d7632f-4a66-4b6b-b882-6d30c6c4eb00","name":"Propel APIs","description":"## Introduction: Propel APIs vs. SFDC\n\nPropel provides coarse-grained REST APIs that address common integration use cases. Endpoints are typically resource-based and accept JSON encoded request payloads and return JSON encoded responses using standard HTTP response codes and authentication mechanisms.\n\nThere are two APIs currently available. Both APIs require authentication and all requests are made within the scope of the permissions of the requesting user.\n\n1. Click **Propel APIs**\n    \n2. Open the **Authorization** tab. The authorization type should be set to OAuth 2.0.\n    \n3. Click **Get New Access Token**. This opens a browser tab with the Salesforce login screen.\n    \n4. Log in to your Salesforce org.\n    \n5. Click **Allow** to grant access to \"Propel APIs Collection for Postman\" to your org.At this point, if your environment is correctly set up, you should see a success message and you should be redirected to the Postman app.  \n    If the redirection doesn't happen, you may need to authorize popups in your browser.  \n    Click here for instructions on how to authorize popups.  \n    Note: these instructions are for Chrome but the steps should be similar with other browsers.\n    \n    1. Click the popup error in the address bar, choose to allow popups from Postman:\n        \n    2. Refresh the page and allow the browser to open the Postman app:\n        \n6. Copy the value of the `instance_url` field from the token details view. Make sure not to copy the line break character.\n    \n7. Click **Use Token**.\n    \n8. Open the **Variables** tab.\n    \n9. Update the `CURRENT VALUE` of the `endpoint` variable with the value that you just copied from the `instance_url` field in the access token details.\n    \n10. Click **Save**.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"37505638","collectionId":"37d7632f-4a66-4b6b-b882-6d30c6c4eb00","publishedId":"2sAYQgi9MH","public":true,"publicUrl":"https://developer.propelsoftware.com","privateUrl":"https://go.postman.co/documentation/37505638-37d7632f-4a66-4b6b-b882-6d30c6c4eb00","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"25a8ba"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Propel provides coarse-grained REST APIs that address common integration use cases. Endpoints are typically resource-based and accept JSON-encoded request payloads and returns."},{"name":"title","value":"Propel Software API | Developer Docs"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/54cdcbbb-e0f6-4652-82d0-bc0851ebfc50/bG9nb18zNjB4MTQ0X3BuZy5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"25a8ba"}},{"name":"light","logo":"https://content.pstmn.io/54cdcbbb-e0f6-4652-82d0-bc0851ebfc50/bG9nb18zNjB4MTQ0X3BuZy5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"25a8ba"}}]}},"version":"8.11.4","publishDate":"2025-02-06T19:37:40.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Propel Software API | Developer Docs","description":"Propel provides coarse-grained REST APIs that address common integration use cases. Endpoints are typically resource-based and accept JSON-encoded request payloads and returns."},"logos":{"logoLight":"https://content.pstmn.io/54cdcbbb-e0f6-4652-82d0-bc0851ebfc50/bG9nb18zNjB4MTQ0X3BuZy5wbmc=","logoDark":"https://content.pstmn.io/54cdcbbb-e0f6-4652-82d0-bc0851ebfc50/bG9nb18zNjB4MTQ0X3BuZy5wbmc="}},"statusCode":200},"environments":[{"name":"Propel APIs Environment","id":"0c921859-6aa9-4136-95bc-e68ce9a8c8e8","owner":"37504674","values":[{"key":"endpoint","value":"{{endpoint}}","enabled":true,"type":"default"},{"key":"namespace","value":"PDLM","enabled":true,"type":"default"},{"key":"baseUrl","value":"{{endpoint}}/services/apexrest/{{namespace}}","enabled":true,"type":"default"},{"key":"pimBaseUrl","value":"{{endpoint}}/services/apexrest{{pimNamespace}}","enabled":true,"type":"default"},{"key":"pimNamespace","value":"/PIM","enabled":true,"type":"default"},{"enabled":true,"key":"propelApiUrl","value":"","type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/4f5fde868f5a00a4851ac13901ba09636792b866e1ea7819dae6b7846d709ec7","favicon":"https://propelsoftware.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Propel APIs Environment","value":"37504674-0c921859-6aa9-4136-95bc-e68ce9a8c8e8"}],"canonicalUrl":"https://developer.propelsoftware.com/view/metadata/2sAYQgi9MH"}