This Service will only export external apis
\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.
\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 is a free tool that helps developers run and debug API requests.
\nOur APIs are based around REST architecture and use the basic HTTP request methods. Our APIs accept JSON - encoded body requests and return data in the same form.
\nFirst, you need to register with salessimplify and create an account. Click on this link to complete the sign-up process.
\nAfter the sign-up process is complete, follow the enlisted steps to create an API user:
\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\nHow 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
In 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\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19624715","collectionId":"34fd26a4-ea1b-44ad-8370-ada6c8c45485","publishedId":"UVkgyzaj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0198e9"},"publishDate":"2022-02-16T11:35:19.000Z"},"item":[{"name":"Campaign - Send Email","item":[{"name":"Send Email","id":"4579a3eb-8217-440a-aa92-bc22555ce3ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to\": [\n \"sample@gmail.com\"\n ],\n \"subject\": \"API test 1\",\n \"from\": \"test@domain.com\",\n \"fromName\": \"sahil\",\n \"bodyHtml\": \"Note: Campaign module is excepted from daily api usage policy.
\n
This endpoint allows you to send an email.
\nBelow API used to upload attachments in salessimplify platform.\nPurpose of API is whenever the user wants to send an attachment in the email. user need to upload attachment in salessimplify platform first. salessimplify will provide id represents to attachment. and the user can send this id in send email API's attachment field to send attachment along with the email.
\nWhat is an email API? An email API (application programming interface) gives applications access to the functionality available in an email platform, such as generating and sending transactional emails, manipulating templates, and enabling access to email metrics.\nSales Simplify provides a service named Email API. An email API service allows you to send email communications to large lists of multiple recipients by incorporating email into your applications. \nOur email API allows you to send emails to users around the globe through simple RESTful APIs. You can send one email to many people, or a unique email to each person on your list with an email API service.\nYou can send marketing messages, newsletters, updates, coupons, and invitations through email API.
\n","_postman_id":"10dc77d5-5011-411d-ac1c-95a937f1d4e3","auth":{"type":"bearer","bearer":{"token":"To make it simple, We have designed a method which allows you to send SMS in a single line of the HTTP GET request:
\n\n\nIf you are sending an SMS using a GET URL, it is necessary to encode the message using the URL Encoding method before sending it. However, if you are using a POST API, there is no need to encode the message.
\n
\n\nFor example, if the message is \"Hi User 1 & User 2, Welcome to salessimplify,\" it needs to be encoded as \"Hi%20User%201%20%26%20User%202%2C%20Welcome%20to%20salessimplify\" using URL Encoding.
\n
\n\nYou can use a tool like https://www.urlencoder.org/ for reference on how to properly encode your message.
\n
\n\nhttps://api.salessimplify.com/api/apis/campaign/sms/send?apiKey=3456789&senderId=IDENTY&route=transactional&number=919090909090&message=Your OTP is 0101&isFlash=true&dltTemplateId=1234&dltEntityId=1234&reportURL=https://webhook.site/0a276bc5-f0e4-4235-9006-b58b&submissionStatus=true
\n
In order to get delivery reports directly into your system you need to take care of few simple things.
\nIn order to get delivery reports directly into your system you need to take care of few simple things.
\nSalessimplify makes sending and receiving SMS easy. Find the documentation, sample codes and developer tools you need to build exactly what you want, fast & secure. We’ll handle all the complexity of mobile operators and global regulations. Let’s get building.
\nOur SMS API allows you to send text messages to users around the globe through simple RESTful APIs.
\n","_postman_id":"927d2628-6f2c-4da2-b0fc-513a84af408e","auth":{"type":"bearer","bearer":{"token":"To know all required variable and their keys for selected template, use above Get Template Variable API. It will return response as
\n{\n \"status\": true,\n \"message\": \"Success\",\n \"data\": [\n {\n \"label\": \"Header Image\",\n \"keyName\": \"image\",\n \"type\": \"IMAGE_URL\"\n },\n {\n \"label\": \"Body 1\",\n \"keyName\": \"body_1\",\n \"type\": \"TEXT\"\n }\n ]\n}\nFor above variable response the varibales value will be
\n{\n variables:{\n \"image\": \"<image-url>\",\n \"body_1\": \"<variable-text>\"\n\n ....\n\n [keyName]:\"<variable-value>\"\n }\n}\nFor
\n","urlObject":{"path":["api","v1","campaign","whatsapp","send"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba5e3fad-31f0-4c58-b635-f65c42a77e97"}],"id":"b030f7ab-2c9f-498a-aa06-cc5d4ade2afe","_postman_id":"b030f7ab-2c9f-498a-aa06-cc5d4ade2afe","description":"","auth":{"type":"bearer","bearer":{"token":"Returns multiple leads based on query parameters. Leads are sorted by the time they were created, from newest to oldest. Pagination can be controlled using limit and pageNo query parameters. If a lead contains custom fields, the fields' values will be included in the response in a name of customFields. If a custom field's value hasn't been set for the lead, it won't appear in the response. The customFields is a object represent all custom field keys with there value which are set in lead. for example
{\n ..., //lead system data\n customFields :{\n key1: <value>\n key2: <value>\n }\n}\nThe success response provides lead data, pagination and related object data.
\ntags, owner, company and followers id instead of data. that data present in relatedObject.Deletes a specific lead by id.
\nDeletes a specific lead by ids in bulk. The comma-separated IDs that will be deleted
\nLeads are prospective deals stored in leads to convert then to junk or deal. valid leads become deal by converting them into deal with addition data like deal title, deal value and expected date,etc.
\n","_postman_id":"a75a5dfb-a4e8-4436-ad26-4c7df0d20ae7","auth":{"type":"bearer","bearer":{"token":"Returns data about all lead fields.
\n","auth":{"type":"bearer","bearer":{"token":"Returns data of selected lead field.
\n","auth":{"type":"bearer","bearer":{"token":"Create a lead custom field.
\nUpdates a lead custom field.
\nIt deletes custom field. After deleting, field related values stored in lead table cant be restored.
\nLead fields represent the relatively complete schema for a lead in an account. Each company account can have a different schema for their lead, with various custom fields. each data field value describes their behavior with a set of keys and values. Fields are separated into system and custom fields where system fields are pre-defined fields that are defined by the system and are not updatable by API whereas custom fields can be added, modified, and deleted by the user. Whenever a user wanted some extra data on a lead where he can't utilize pre-defined system fields, their custom fields are used.
\nfield input type represent current field data type. which means what kind of data it accept and provides as output.
\nField type defines the current field belongs to which module. below are the modules which data will be given to user.
\n","_postman_id":"e1bf4311-9714-4709-a867-15655628e97e","auth":{"type":"bearer","bearer":{"token":"It will return details of all lead tags. This endpoint does not support pagination and all tags are always returned.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a lead tag.
\nThis endpoint will Updates one or more properties of a lead tag. both name and colorCode properties required in update tag.
Deletes a specific lead tag.
\nIt will returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the Public Salessimplify API will have a lead source API assigned.
\n","auth":{"type":"bearer","bearer":{"token":"A lead source indicates where your lead came from. Currently, these are the possible lead sources: Manually created, Deal, Web Forms, Prospector, Chatbot, Live Chat, Import, Web Visitors, Workflow Automation, and API. Lead sources are pre-defined and cannot be edited.
It returns all lead outcomes
\n","auth":{"type":"bearer","bearer":{"token":"Returns all deals based on query data provided.
\nThe success response provides deal data, pagination and related object data.
\ntags, owner,pipelineId,stageId,initialStageId, dealLostReason, people and company id instead of data. that data present in relatedObject.Returns selected deal.
\nThe success response provides deal data, pagination and related object data.
\ntags, owner,pipelineId,stageId,initialStageId, dealLostReason, people and company id instead of data. that data present in relatedObject.It creates new deal.
\nIt update deal.
\nIt deletes deal.
\nIt marks deal as won.
\nIt marks deal as lost.
\nIt marks deal as archive.
\nIt will return details of all deal tags. This endpoint does not support pagination and all tags are always returned.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a deal tag.
\nThis endpoint will Updates one or more properties of a deal tag. both name and colorCode properties required in update tag.
Deletes a specific deal tag.
\nGet List Of All Pipelines.
\nIt returns selected pipeline data with stages.
\nCreates new pipeline for deals.
\nUpdates pipeline name.
\nDeletes Pipeline if there no deal associated with it.
\nCreates new pipeline stage for pipeline.
\nUpdates the properties of a pipeline stage by stage id.
\nDeletes a specific stage of pipeline by id.
\nIt changes the order of stage in pipeline. It accept order in number form and place stage on provided position. reorder remaining stages based on current stage change.
\nPipelines are collection of stages where all deals get categorise by stages.
\n","_postman_id":"94774c97-f99c-447d-8149-230925a06005","auth":{"type":"bearer","bearer":{"token":"It Returns all deal lost reasons.
\n","auth":{"type":"bearer","bearer":{"token":"Returns all activities assigned to a particular user with provided data.
\nThe success response provides activity data, pagination and related object data.
\ntags, owner, followers, assignToUser, activityType, activityLostReason, lead, people, company and deal id instead of data. that data present in relatedObject.Returns selected activity.
\nThe success response provides activity data, pagination and related object data.
\ntags, owner, followers, assignToUser, activityType, activityLostReason, lead, people, company and deal id instead of data. that data present in relatedObject.Creates New Activity.
\nUpdates selected activity.
\nIt deletes activity.
\nIt will return details of all activity tags. This endpoint does not support pagination and all tags are always returned.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a acctivity tag.
\nThis endpoint will Updates one or more properties of a activity tag. both name and colorCode properties required in update tag.
Deletes a specific activity tag.
\nIt returns all activity types.
\nIt returns only active activity types which gonna be use in activities.
\nIt created new activity type which gonna be used in activities.
\nIt updates activity type data.
\nIt deleted activity type.
\nActivity types represent different kinds of activities that can be stored. Each activity type is presented to the user with an icon and a name. Activity types are linked to activities via activity type id.
\n","_postman_id":"fac128e2-206c-4168-8d90-2f64a24d0cd0","auth":{"type":"bearer","bearer":{"token":"It returns all activity outcomes
\n","auth":{"type":"bearer","bearer":{"token":"Old API will work till August 2022..
\n","_postman_id":"0b03a3f3-face-49e9-a758-c922f6d51c84","auth":{"type":"bearer","bearer":{"token":"Returns all activities assigned to a particular user with provided data.
\nThe success response provides activity data, pagination and related object data.
\nowner, assignToUser, activityType, activityLostReason and associated id instead of data. that data present in relatedObject.Returns selected activity.
\nThe success response provides activity data, pagination and related object data.
\nowner, assignToUser, activityType, activityLostReason and associated id instead of data. that data present in relatedObject.Creates New Activity.
\nUpdates selected activity.
\nIt deletes activity.
\nIt returns all activity types.
\nIt returns only active activity types which gonna be use in activities.
\nIt created new activity type which gonna be used in activities.
\nIt updates activity type data.
\nIt deleted activity type.
\nActivity types represent different kinds of activities that can be stored. Each activity type is presented to the user with an icon and a name. Activity types are linked to activities via activity type id.
\n","_postman_id":"a52ccb8a-3e6a-4d41-8e2a-ead21b60520e","auth":{"type":"bearer","bearer":{"token":"It returns all activity outcomes
\n","auth":{"type":"bearer","bearer":{"token":"Deployment Date - 20 Jun 2022
\n","_postman_id":"49c1fed3-5017-4a22-9c3d-7fcea8270b30","auth":{"type":"bearer","bearer":{"token":"Returns multiple peoples based on query parameters. Peoples are sorted by the time they were created, from newest to oldest. Pagination can be controlled using limit and pageNo query parameters. If a people contains custom fields, the fields' values will be included in the response in a name of customFields. If a custom field's value hasn't been set for the lead, it won't appear in the response. The customFields is a object represent all custom field keys with there value which are set in people. for example
{\n ..., //lead system data\n customFields :{\n key1: <value>\n key2: <value>\n }\n}\nThe success response provides people data, pagination and related object data.
\ntags, owner, company and followers id instead of data. that data present in relatedObject.Deletes a specific people by id.
\nDeletes a specific people by ids in bulk. The comma-separated IDs that will be deleted
\nReturns data about all people fields.
\n","auth":{"type":"bearer","bearer":{"token":"Returns data of selected people field.
\n","auth":{"type":"bearer","bearer":{"token":"Create a people custom field.
\nUpdates a people custom field.
\nIt deletes custom field. After deleting, field related values stored in people table cant be restored.
\nPeople fields represent the relatively complete schema for a people in an account. Each people account can have a different schema for their people, with various custom fields. each data field value describes their behavior with a set of keys and values. Fields are separated into system and custom fields where system fields are pre-defined fields that are defined by the system and are not updatable by API whereas custom fields can be added, modified, and deleted by the user. Whenever a user wanted some extra data on a people where he can't utilize pre-defined system fields, their custom fields are used.
\nfield input type represent current field data type. which means what kind of data it accept and provides as output.
\nField type defines the current field belongs to which module. below are the modules which data will be given to user.
\n","_postman_id":"d5947f1e-ae41-402e-ab78-de092a749d51","auth":{"type":"bearer","bearer":{"token":"It will return details of all people tags. This endpoint does not support pagination and all tags are always returned.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a people tag.
\nThis endpoint will Updates one or more properties of a people tag. both name and colorCode properties required in update tag.
Deletes a specific people tag.
\nReturns multiple companies based on query parameters. Company are sorted by the time they were created, from newest to oldest. Pagination can be controlled using limit and pageNo query parameters. If a company contains custom fields, the fields' values will be included in the response in a name of customFields. If a custom field's value hasn't been set for the company, it won't appear in the response. The customFields is a object represent all custom field keys with there value which are set in people. for example
{\n ..., //lead system data\n customFields :{\n key1: <value>\n key2: <value>\n }\n}\nThe success response provides people data, pagination and related object data.
\nRequired
\n","type":"text/plain"},"type":"any","value":null,"key":"companyId"}]}},"response":[{"id":"bb94856b-6917-4022-bcb2-93d2149a45e9","name":"200 - Success","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/company/61fd61461833b67159491bce"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2392"},{"key":"ETag","value":"W/\"958-LCS7uUR8LzC3tJc7gGTpgCGd914\""},{"key":"Date","value":"Thu, 10 Feb 2022 06:02:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"successfully retrived\",\n \"data\": {\n \"_id\": \"61fd61461833b67159491bce\",\n \"followers\": [\n \"60ed49d587537a4ba4b03dd0\"\n ],\n \"tags\": [\n \"61ee826a3c7a7f657a05297d\"\n ],\n \"phone\": [\n 915467897654\n ],\n \"otherPhone\": [\n 919876543456\n ],\n \"email\": [\n \"support@saino.io\"\n ],\n \"otherEmail\": [\n \"SAHIL@SAIN.ui\"\n ],\n \"totalActivities\": 0,\n \"doneActivities\": 0,\n \"activitiesToDo\": 0,\n \"owner\": \"60ca65a4b8d2833cc097f5a9\",\n \"name\": \"saino\",\n \"website\": \"www.saino.io\",\n \"createdAddress\": \"test\",\n \"searchText\": \" 915467897654 919876543456 support@saino.io SAHIL@SAIN.ui Active saino www.saino.io test USD Analyst Meat processing & products test test qw weq India Maharashtra Dombivali test.skype.com www.linkedin.com\",\n \"createdAt\": \"2022-02-04T17:24:22.968Z\",\n \"updatedAt\": \"2022-02-09T11:25:24.380Z\",\n \"currency\": \"USD\",\n \"businessType\": \"Analyst\",\n \"industryType\": \"Meat processing & products\",\n \"description\": \"test test\",\n \"shippingAddressLine2\": \"qw\",\n \"shippingAddressLine1\": \"weq\",\n \"shippingCountry\": \"India\",\n \"shippingState\": \"Maharashtra\",\n \"shippingCity\": \"Dombivali\",\n \"numberOfEmployees\": 10,\n \"skypeId\": \"test.skype.com\",\n \"annualRevenue\": 199999999,\n \"createdLatitude\": 21.34,\n \"createdLongitude\": 111,\n \"linkedInHandle\": \"www.linkedin.com\"\n },\n \"relatedObject\": {\n \"tags\": {\n \"61ee826a3c7a7f657a05297d\": {\n \"_id\": \"61ee826a3c7a7f657a05297d\",\n \"name\": \"Tag from API\",\n \"colorCode\": \"#ff00ff\"\n }\n },\n \"owner\": {\n \"60ca65a4b8d2833cc097f5a9\": {\n \"fullName\": \"sahil Khaire\",\n \"userId\": \"60ca65a4b8d2833cc097f5a9\",\n \"email\": \"sahil@saino.io\",\n \"userType\": \"OWNER\",\n \"avatar\": \"https://salessimplify.s3.ap-south-1.amazonaws.com/profile-picture/60ca65a3b8d2833cc097f5a8_scaled_0cd48521-679d-427c-ad94-b29dc336a63e2263121557061650365.jpg\"\n },\n \"60ed49d587537a4ba4b03dd0\": {\n \"email\": \"admin@saino.io\",\n \"userId\": \"60ed49d587537a4ba4b03dd0\",\n \"userType\": \"ADMIN\",\n \"avatar\": \"https://salessimplify.s3.ap-south-1.amazonaws.com/profile-picture/60ca65a3b8d2833cc097f5a8_avatar.jpg\",\n \"fullName\": \"admin\"\n }\n },\n \"followers\": {\n \"60ca65a4b8d2833cc097f5a9\": {\n \"fullName\": \"sahil Khaire\",\n \"userId\": \"60ca65a4b8d2833cc097f5a9\",\n \"email\": \"sahil@saino.io\",\n \"userType\": \"OWNER\",\n \"avatar\": \"https://salessimplify.s3.ap-south-1.amazonaws.com/profile-picture/60ca65a3b8d2833cc097f5a8_scaled_0cd48521-679d-427c-ad94-b29dc336a63e2263121557061650365.jpg\"\n },\n \"60ed49d587537a4ba4b03dd0\": {\n \"email\": \"admin@saino.io\",\n \"userId\": \"60ed49d587537a4ba4b03dd0\",\n \"userType\": \"ADMIN\",\n \"avatar\": \"https://salessimplify.s3.ap-south-1.amazonaws.com/profile-picture/60ca65a3b8d2833cc097f5a8_avatar.jpg\",\n \"fullName\": \"admin\"\n }\n }\n }\n}"},{"id":"46e6a005-098e-4d46-bbcf-396dab1683c3","name":"400 - Error (Product Not found)","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/company/61fd61461833b67159491bcc"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"46"},{"key":"ETag","value":"W/\"2e-49pqbXG2qETmDFhjOd96+dYkyqA\""},{"key":"Date","value":"Thu, 10 Feb 2022 06:02:53 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"message\": \"Product not found\"\n}"}],"_postman_id":"c26954ff-c9c1-4668-82ad-4244ab0b5b72"},{"name":"Create Company","id":"6366d443-5e49-4e40-bb66-f949f2989d8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Company\",\n \"description\": \"Test description\",\n \"website\": \"www.demo.com\",\n \"createdAddress\": \"Test Address\",\n \"owner\": \"60ca65a4b8d2833cc097f5a9\",\n \"followers\": \"60ca65a4b8d2833cc097f5a9\",\n \"currency\": \"USD\",\n \"numberOfEmployees\": 500,\n \"annualRevenue\": 1000000,\n \"skypeId\": \"www.skype.com/demoid\",\n \"tags\": [\n \"61ee826a3c7a7f657a05297d\"\n ],\n \"phone\": [\n 9876543212\n ],\n \"otherPhone\": [\n 98765432112\n ],\n \"email\": [\n \"test@demo.com\"\n ],\n \"otherEmail\": [\n \"test2@demo.com\"\n ],\n \"smsOptOut\": false,\n \"emailOptOut\": false,\n \"createdLongitude\": 10.12,\n \"createdLatitude\": -12.22,\n \"noOfPeoples\": 1000,\n \"linkedInHandle\": \"https://www.linkedin.com\",\n \"googlePlusHandle\": \"https://www.google.com\",\n \"twitterHandle\": \"https://www.twitter.com\",\n \"instagramHandle\": \"https://www.instagram.com\",\n \"facebookHandle\": \"https://www.facebook.com\",\n \"latitude\": 10.12,\n \"longitude\": -12.12,\n \"billingCity\": \"Newark\",\n \"billingState\": \"New Jersey\",\n \"billingCountry\": \"United States\",\n \"billingZipCode\": 31901,\n \"billingAddressLine1\": \"3518 Beechwood Avenue\",\n \"billingAddressLine2\": \"-\",\n \"shippingCity\": \"Columbus\",\n \"shippingState\": \"Georgia\",\n \"shippingCountry\": \"United States\",\n \"shippingZipCode\": 31901,\n \"shippingAddressLine1\": \"4556 Hart Country Lane\",\n \"shippingAddressLine2\": \"-\",\n \"industryType\": \"\",\n \"businessType\": \"\",\n \"customFields\": {\n \"TestField\": \"testing\",\n \"TestField1\": \"testing1\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/company","auth":{"type":"bearer","bearer":{"token":"Deletes a specific company by ids in bulk. The comma-separated IDs that will be deleted
\nDeletes a specific company by id.
\nReturns data about all company fields.
\n","auth":{"type":"bearer","bearer":{"token":"Returns data of selected company field.
\n","auth":{"type":"bearer","bearer":{"token":"Create a company custom field.
\nUpdates a company custom field.
\nIt deletes custom field. After deleting, field related values stored in company table cant be restored.
\nCompany fields represent the relatively complete schema for a company in an account. Each company account can have a different schema for their company, with various custom fields. each data field value describes their behavior with a set of keys and values. Fields are separated into system and custom fields where system fields are pre-defined fields that are defined by the system and are not updatable by API whereas custom fields can be added, modified, and deleted by the user. Whenever a user wanted some extra data on a company where he can't utilize pre-defined system fields, their custom fields are used.
\nfield input type represent current field data type. which means what kind of data it accept and provides as output.
\nField type defines the current field belongs to which module. below are the modules which data will be given to user.
\n","_postman_id":"e19e2891-13fe-4bc7-8195-ff8df7c00f6c","auth":{"type":"bearer","bearer":{"token":"It will return details of all company tags. This endpoint does not support pagination and all tags are always returned.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a company tag.
\nThis endpoint will Updates one or more properties of a company tag. both name and colorCode properties required in update tag.
Deletes a specific company tag.
\nReturns multiple Products based on query parameters. Products are sorted by the time they were created, from newest to oldest. Pagination can be controlled using limit and pageNo query parameters. If a Product contains custom fields, the fields' values will be included in the response in a name of customFields. If a custom field's value hasn't been set for the product, it won't appear in the response. The customFields is a object represent all custom field keys with there value which are set in lead. for example
{\n ..., //product system data\n customFields :{\n key1: <value>\n key2: <value>\n }\n}\nThe success response provides product data, pagination and related object data.
\ntags, owner and category id instead of data. that data present in relatedObject.Returns data about a specific product.
\nIt creates product.
\nThis endpoint will Updates one or more properties of a products.
\nDeletes a specific product by id.
\nDeletes a specific product by ids in bulk. The comma-separated IDs that will be deleted
\nProducts are the products or services you are dealing with.Each product can have N different price and currencies. Sales simplify support different prices with different currencies to access products in deal. product used in deals and based on value provided for products while creating deal the deal value gets calculated.
\n","_postman_id":"7da1320a-dcba-4d7b-9d0b-ba0f63c74eed","auth":{"type":"bearer","bearer":{"token":"Returns data about all product fields.
\n","auth":{"type":"bearer","bearer":{"token":"Returns data of selected product field.
\n","auth":{"type":"bearer","bearer":{"token":"Create a product custom field.
\nUpdates a product custom field.
\nIt deletes custom field. After deleting, field related values stored in product table cant be restored.
\nProduct fields represent the relatively complete schema for a product in an account. Each product account can have a different schema for their product, with various custom fields. each data field value describes their behavior with a set of keys and values. Fields are separated into system and custom fields where system fields are pre-defined fields that are defined by the system and are not updatable by API whereas custom fields can be added, modified, and deleted by the user. Whenever a user wanted some extra data on a product where he can't utilize pre-defined system fields, their custom fields are used.
\nfield input type represent current field data type. which means what kind of data it accept and provides as output.
\nField type defines the current field belongs to which module. below are the modules which data will be given to user.
\n","_postman_id":"441cd15f-1f05-426f-a852-b78e2ca6a331","auth":{"type":"bearer","bearer":{"token":"It will return details of all product tags. This endpoint does not support pagination and all tags are always returned.
\n","auth":{"type":"bearer","bearer":{"token":"Creates a product tag.
\nThis endpoint will Updates one or more properties of a lead tag. both name and colorCode properties required in product tag.
Deletes a specific product tag.
\nGet List of Product categories
\n","auth":{"type":"bearer","bearer":{"token":"Creates product category to categories products in category.
\nUpdates product category
\nDeletes product category.
\nProduct categories used to categorise products in different sections based on category name.
\n","_postman_id":"32673e7c-862b-4ab7-8285-f37af4f79ea3","auth":{"type":"bearer","bearer":{"token":"Returns active user list.
\nIt returns active currency list. sales simplify provide list of currencies in admin settings. admin or owner can able to manage which currency should be visible in currency drop-down. all active currency selected by admin or owner are returned in active currency list API.
\n","auth":{"type":"bearer","bearer":{"token":"It will return predefined country list which salessimplify using for country field in lead, people and company table. its not compulsory to use provided country data.
\n","auth":{"type":"bearer","bearer":{"token":"It will return predefined timezone list which salessimplify using for timezone field in lead, people and company table. its not compulsory to use provided timezone data.
\n","auth":{"type":"bearer","bearer":{"token":"Webhooks allows you to receive programmatic notifications from Sales Simplify regarding changes to your data as they occur.
\nInstead of requiring you to pull information through our API, webhooks will push the information to your endpoint. When any of these events are triggered, Salessimplify sends this notification as a HTTP POST request with a JSON body, at the termination point you specify.
\nSetup:
\nWhen we detect any change salessimplify in data, a POST request is made to the callback URL you added to your Sales simplify account.
\nWebhook Specifications:
\n![https://salessimplify.s3.ap-south-1.amazonaws.com/some-path/some-id.jpg](\"https://salessimplify.s3.ap-south-1.amazonaws.com/some-path/some-id.jpg\"){kind=link}
Content-Type header should be set to application/jsonWebhook format:
\n{\n \"meta\": {\n \"action\": \"added\",\n \"account_id\": xxxxx,\n \"user_id\": xxxxx,\n \"timestamp\": 1523440213000\n },\n \"retry\": 0,\n \"data\": (the detailed data),\n \"event\": \"event name\"\n\n\n}\nWebhook Data Format:
\nSchemas:
\nSchema defines the data object of approprite module.
\nLeadSchema - Described in Add Lead API Add Lead API
\nDealSchema - Described in Add Deal API Add Deal API
\nActivitySchema - Described in Add Activity API Add Activity API
\nPeopleSchema - Described in Add People API Add People API
\nCompanySchema - Described in Add Company API Add Company API
\nProductSchema - Described in Add Product API Add Product API
\n{\n \"meta\": {\n \"type\": \"webhook\",\n \"event\": \"Lead Updated\",\n \"accountId\": \"6298cc9a261ad1acd835ceef\",\n \"userId\": \"6298cc9a261ad1acd835cef0\",\n \"timestamp\": 1664364331990,\n \"url\": \"https://webhook.site/26de5b72-5483-4859-8bd7-31be6ff1f0b1\",\n \"webhookId\": \"6333f2c7fb4f29ddeceb7fbb\"\n },\n \"retry\": 0,\n \"data\": {\n \"_id\": \"6298cc9ed0b022c265fbc33a\",\n \"tags\": [\n {\n \"_id\": \"6298cc9dd0b022c265fbc2a6\",\n \"name\": \"Hot\",\n \"colorCode\": \"#f6a6c2\"\n },\n {\n \"_id\": \"6298cc9dd0b022c265fbc2a9\",\n \"name\": \"Follow-up\",\n \"colorCode\": \"#cc8aff\"\n }\n ],\n \"mobile\": [],\n \"phone\": [\n 3103636001\n ],\n \"otherPhone\": [],\n \"email\": [\n \"sales@spacex.com\"\n ],\n \"otherEmail\": [],\n \"name\": \"Elon Musk\",\n \"firstName\": \"Elon\",\n \"lastName\": \"Musk\",\n \"company\": {\n \"_id\": \"6298cc9ed0b022c265fbc337\",\n \"name\": \"SpaceX\",\n \"website\": \"\"\n },\n \"createdAddress\": \"1 Rocket Road Hawthorne\",\n \"billingCity\": \"Seattle\",\n \"billingCountry\": \"USA\",\n \"billingState\": \"CA\",\n \"billingZipCode\": \"90250\",\n \"website\": \"http://www.spacex.com\",\n \"owner\": {\n \"_id\": \"6298cc9a261ad1acd835cef0\",\n \"fullName\": \"sahil\",\n \"email\": \"sahil51@saino.io\",\n \"userType\": \"OWNER\"\n },\n \"source\": \"Manually created\",\n \"createdAt\": \"2022-06-02T14:43:42.070Z\",\n \"updatedAt\": \"2022-09-28T11:25:31.979Z\",\n \"followers\": null\n },\n \"current\": {},\n \"previous\": {},\n \"event\": \"Lead Updated\"\n}\n\nWebhook format:
\n{\n \"meta\": {\n \"action\": \"added\",\n \"account_id\": xxxxx,\n \"user_id\": xxxxx,\n \"timestamp\": 1523440213000\n },\n \"retry\": 0,\n \"current\": (the object data as of this update),\n \"previous\": (the object data prior to this update),\n \"event\": \"event name\"\n}\nWebhook Data Format:
\nSchemas:
\nSchema defines the data object of approprite module.
\nLeadSchema - Described in Add Lead API Add Lead API
\nDealSchema - Described in Add Deal API Add Deal API
\nActivitySchema - Described in Add Activity API Add Activity API
\nPeopleSchema - Described in Add People API Add People API
\nCompanySchema - Described in Add Company API Add Company API
\nProductSchema - Described in Add Product API Add Product API
\n{\n \"meta\": {\n \"event\": \"Lead Updated\",\n \"accountId\": \"621788c9b5695b09af916f9f\",\n \"userId\": \"621788c9b5695b09af916fa0\",\n \"timestamp\": 1647587021935,\n \"url\": \"https://xyz.site/b7ff84d6-a7ec-45c3-a45e-de2355f79734\",\n \"webhookId\": \"62342c9cb2910f4b103d4764\"\n },\n \"retry\": 0,\n \"current\": {\n \"_id\": \"622edeaaa7b3ec72cde9c797\",\n \"state\": \"active_lead\",\n \"isDeleted\": false,\n \"tags\": [\n \"621788cd4620ca0620af859c\"\n ],\n \"mobile\": [],\n \"phone\": [],\n \"otherPhone\": [],\n \"email\": [\n \"mwantlingrp@narod.ru\"\n ],\n \"otherEmail\": [],\n \"mergedIds\": [],\n \"owner\": \"621788c9b5695b09af916fa0\",\n \"firstName\": \"Merrill\",\n \"lastName\": \"Wantling\",\n \"website\": \"https://techcrunch.com/vel/nulla.aspx\",\n \n \"source\": \"Import\",\n \"name\": \"Merrill Wantling\",\n \"__v\": 0,\n \"createdAt\": \"2022-03-14T06:20:27.543Z\",\n \"updatedAt\": \"2022-03-18T07:03:41.917Z\"\n },\n \"previous\": {\n \"_id\": \"622edeaaa7b3ec72cde9c797\",\n \"state\": \"active_lead\",\n \"isDeleted\": false,\n \"tags\": [],\n \"mobile\": [],\n \"phone\": [],\n \"otherPhone\": [],\n \"email\": [\n \"mwantlingrp@narod.ru\"\n ],\n \"otherEmail\": [],\n \"mergedIds\": [],\n \"owner\": \"621788c9b5695b09af916fa0\",\n \"firstName\": \"Merrill\",\n \"lastName\": \"Wantling\",\n \"website\": \"https://techcrunch.com/vel/nulla.aspx\",\n \"source\": \"Import\",\n \"name\": \"Merrill Wantling\",\n \"__v\": 0,\n \"createdAt\": \"2022-03-14T06:20:27.543Z\",\n \"updatedAt\": \"2022-03-14T06:20:27.543Z\"\n },\n \"event\": \"Lead Updated\"\n}\n\nWhile using salessimplify's APIs, you may run into some standard response and error codes. The most common ones are listed along with their descriptions as follows:
\n