{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"34fd26a4-ea1b-44ad-8370-ada6c8c45485","name":"Sales Simplify API","description":"This Service will only export external apis\n\n\nWelcome to Salessimplify's API Documentation. We've designed this document to help developers and salessimplify users fully understand and integrate our API for a seamless and easy deployment. These APIs enable you to utilize most of your salessimplify account's panel features fully.\n\nWe've listed all the APIs, their required parameters, and their example requests and responses on the right for easy understanding. The easiest way to start using the salessimplify APIs is by clicking the **Run in Postman** button above. The [Postman](https://www.getpostman.com/) is a free tool that helps developers run and debug API requests.\n\nOur APIs are based around REST architecture and use the basic [HTTP](https://www.tutorialspoint.com/http/http_status_codes) request methods. Our APIs accept [JSON](https://www.w3schools.com/whatis/whatis_json.asp) - encoded body requests and return data in the same form.\n\n#### Getting Started\n\nFirst, you need to register with salessimplify and create an account. Click on this [link](https://app.salessimplify.com/auth/registration) to complete the sign-up process.\n\nAfter the sign-up process is complete, follow the enlisted steps to create an API user:\n\n1.  Open your salessimplify account and navigate to the right-hand panel.\n2.  Click On **Profile Icon => Admin Settings => API => Create an API**.\n3.  On the pop-up menu, fill in the **API Name**.\n4.  Click on **'Add API'**. On successful completion, you should have a new API token generated.\n5.  Copy this token and use it to authenticate your further API calls.\n    \n\n#### Document and API Usage Guidelines\n\n*   Our APIs use the basic HTTP request codes: *POST*, *GET*, *PATCH*, *DELETE*.\n*   You can select the required response and request code language by selecting it from the drop-down menu on the top.\n*   You can import and test all our full API collection in the Postman app by clicking on the **' Run in Postman'** button.\n*   **Note**: Any requests made using the valid API credentials will affect the real-time data in your salessimplify account.\n*   Authorization: Bearer\n*   All the APIs are provided with their appropriate example requests and responses for successful and failed calls.\n\n\n#### Support:\n\n*   All the required information on integration is in this document. Please read it thoroughly.\n*   For any integration and API-related support, you can feel free to drop us an email at [***support@salessimplify.com***](mailto:support@salessimplify.com).\n*   The salessimplify terms of service are listed here: [Terms Of Service](https://salessimplify.com/terms-of-service/)\n\n\n#### Daily API fair usage limit for POST/PATCH endpoints\n\nIn addition to rate limiting, public API has a daily API fair usage limit for all POST/PATCH endpoints. Fair usage is considered to be a maximum of 10 000 POST/PATCH requests daily per user per 24 hours. The daily limit will be reset at midnight in UTC.\n\n> How the limit for 10000 requests per day per user is calculated?\nSajin is a user of Salessimplify. He has two custom integrations using the Salessimplify API. Both custom integrations are subject to the same daily limit to make requests against the Salessimplify API on behalf of the user, sajin. So, for example, if one of those integrations is making 350 POST requests per day and the other integration 100 PATCH requests each per day, then there's 10000 - 350 - 100 - 100 = 9450 POST/PATCH requests left for those two integrations to use for the remaining time until the reset.\n\nIn the case of exceeding the 10 000 daily limit on multiple occasions, we may start blocking your POST/PATCH requests towards our API.\n\n> **Note: Campaign module is excepted from daily api usage policy.**","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"19624715","team":3119720,"collectionId":"34fd26a4-ea1b-44ad-8370-ada6c8c45485","publishedId":"UVkgyzaj","public":true,"publicUrl":"https://apidocs.salessimplify.com","privateUrl":"https://go.postman.co/documentation/19624715-34fd26a4-ea1b-44ad-8370-ada6c8c45485","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0198e9"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-02-16T11:35:19.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"LIVE","id":"d9de991c-bfab-4b1f-91c5-fcc5f902d6cf","owner":"19624715","values":[{"key":"base_url","value":"https://api.salessimplify.com","enabled":true}],"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/4ed31d2a16fd426180cc6baf7fb24c9f082659cba6a0fede12c8a4121fab8f86","favicon":"https://res.cloudinary.com/postman/image/upload/v1668183147/team/cuzj23k1cjb0nkop9qwo.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":"LIVE","value":"19624715-d9de991c-bfab-4b1f-91c5-fcc5f902d6cf"}],"canonicalUrl":"https://apidocs.salessimplify.com/view/metadata/UVkgyzaj"}