The Proton API consist of an AI-powered suite of REST API endpoints available to be called to return product recommendations and/or perform actions related to the Proton.ai solutions.
\nFor any requests to go through, a valid API key should be present in the header of the request. The API key will be static - we will supply it at the beginning of the integration and you won't need to dynamically generate or refresh it.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7131210","collectionId":"2179418f-48d4-48ab-a93c-be04465a1f1a","publishedId":"T1DtdadU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2169D4"},"publishDate":"2023-10-13T11:10:19.000Z"},"item":[{"name":"Recommendations","item":[{"name":"(Light) Complete Cart Recommendations","id":"4cd211e2-1386-4e93-8d07-d8a9b9774cb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"url":"{{domain}}/{{company}}/product/recommendations/cart_lite?customer_id={{customer_id}}&count={{count}}&user_id={{user_id}}","description":"This is a different flavor of the same API as the other Complete Cart but the cart is inferred through tracking data. The API only supplies the identifier of the customer and Proton infers the cart based on the items that have been to track in the past 24h.
\nUsage is only suggested for use-cases where the explicit cart is not possible to fetch.
\n","urlObject":{"path":["{{company}}","product","recommendations","cart_lite"],"host":["{{domain}}"],"query":[{"description":{"content":"{{customer_id_description}}
\n","type":"text/plain"},"key":"customer_id","value":"{{customer_id}}"},{"description":{"content":"{{count_description}}
\n","type":"text/plain"},"key":"count","value":"{{count}}"},{"description":{"content":"{{user_id_description}}
\n","type":"text/plain"},"key":"user_id","value":"{{user_id}}"}],"variable":[]}},"response":[],"_postman_id":"4cd211e2-1386-4e93-8d07-d8a9b9774cb3"},{"name":"Reorder Recommendations","id":"31ea1603-499b-41c3-bdf4-e0e55dab1006","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"url":"{{domain}}/{{company}}/product/recommendations/periodic?customer_id={{customer_id}}&count={{count}}&user_id={{user_id}}","description":"Recommends products this customer has purchased before and is due to order again. Proton uses purchasing patterns to prioritize products that the customer is most likely to reorder.
\n","urlObject":{"path":["{{company}}","product","recommendations","periodic"],"host":["{{domain}}"],"query":[{"description":{"content":"{{customer_id_description}}
\n","type":"text/plain"},"key":"customer_id","value":"{{customer_id}}"},{"description":{"content":"{{count_description}}
\n","type":"text/plain"},"key":"count","value":"{{count}}"},{"description":{"content":"{{user_id_description}}
\n","type":"text/plain"},"key":"user_id","value":"{{user_id}}"}],"variable":[]}},"response":[{"id":"bcd891c9-b4f6-4410-9729-7a0664526dfd","name":"Reorder","originalRequest":{"method":"GET","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"url":{"raw":"{{domain}}/{{company}}/product/recommendations/periodic?customer_id={{customer_id}}&count={{count}}&user_id={{user_id}}","host":["{{domain}}"],"path":["{{company}}","product","recommendations","periodic"],"query":[{"key":"customer_id","value":"{{customer_id}}"},{"key":"count","value":"{{count}}"},{"key":"user_id","value":"{{user_id}}","description":"the offset, for quasi-pagination"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.1"},{"key":"Date","value":"Wed, 06 Jul 2022 12:12:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,User-Agent,X-User-ID,X-Company,X-Api-Key,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,X-Proton-Beta,X-Proton-Frontend-Beta,X-Client-Platform,X-Transaction-ID"},{"key":"Access-Control-Expose-Headers","value":"Content-Length,Content-Range"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": [\n {\n \"product_id\": \"ABC\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"DEF\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"GHI\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"JKL\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"MNO\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n }\n ],\n \"product_id\": [\n \"{{product_id}}\"\n ],\n \"customer_id\": [\n \"{{customer_id}}\"\n ],\n \"count\": [\n \"{{count}}\"\n ],\n \"user_id\": [\n \"{{user_id}}\"\n ]\n}"}],"_postman_id":"31ea1603-499b-41c3-bdf4-e0e55dab1006"},{"name":"New Recommendations","id":"1d5a261b-814d-4497-9769-2c9f63036261","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"url":"{{domain}}/{{company}}/product/recommendations?customer_id={{customer_id}}&count={{count}}&user_id={{user_id}}","description":"Recommends products this customer hasn’t ordered before (or recently) that could be a good fit for them. Proton looks at products purchased by similar customers to make these recommendations.
\n","urlObject":{"path":["{{company}}","product","recommendations"],"host":["{{domain}}"],"query":[{"description":{"content":"{{customer_id_description}}
\n","type":"text/plain"},"key":"customer_id","value":"{{customer_id}}"},{"description":{"content":"{{count_description}}
\n","type":"text/plain"},"key":"count","value":"{{count}}"},{"description":{"content":"{{user_id_description}}
\n","type":"text/plain"},"key":"user_id","value":"{{user_id}}"}],"variable":[]}},"response":[{"id":"8a8823ec-b20e-4b80-8d90-ba1b79a29e2d","name":"New Recommendations","originalRequest":{"method":"GET","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"url":{"raw":"{{domain}}/{{company}}/product/recommendations?customer_id={{customer_id}}&count={{count}}&user_id={{user_id}}","host":["{{domain}}"],"path":["{{company}}","product","recommendations"],"query":[{"key":"customer_id","value":"{{customer_id}}"},{"key":"count","value":"{{count}}"},{"key":"user_id","value":"{{user_id}}","description":"the offset, for quasi-pagination"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.1"},{"key":"Date","value":"Wed, 06 Jul 2022 12:12:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,User-Agent,X-User-ID,X-Company,X-Api-Key,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,X-Proton-Beta,X-Proton-Frontend-Beta,X-Client-Platform,X-Transaction-ID"},{"key":"Access-Control-Expose-Headers","value":"Content-Length,Content-Range"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": [\n {\n \"product_id\": \"ABC\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"DEF\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"GHI\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"JKL\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"MNO\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n }\n ],\n \"product_id\": [\n \"{{product_id}}\"\n ],\n \"customer_id\": [\n \"{{customer_id}}\"\n ],\n \"count\": [\n \"{{count}}\"\n ],\n \"user_id\": [\n \"{{user_id}}\"\n ]\n}"}],"_postman_id":"1d5a261b-814d-4497-9769-2c9f63036261"},{"name":"Bought Also Bought","id":"bd1a3af4-b48b-411c-846c-32c0ea4fcf6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"url":"{{domain}}/{{company}}/product/recommendations/bought?customer_id={{customer_id}}&count={{count}}&user_id={{user_id}}&product_id={{product_id}}","description":"Recommends products that are often bought together with the input product. \"People that Buy X also Buy Y\"
\n","urlObject":{"path":["{{company}}","product","recommendations","bought"],"host":["{{domain}}"],"query":[{"description":{"content":"{{customer_id_description}}
\n","type":"text/plain"},"key":"customer_id","value":"{{customer_id}}"},{"description":{"content":"{{count_description}}
\n","type":"text/plain"},"key":"count","value":"{{count}}"},{"description":{"content":"{{user_id_description}}
\n","type":"text/plain"},"key":"user_id","value":"{{user_id}}"},{"description":{"content":"{{product_id_description}}
\n","type":"text/plain"},"key":"product_id","value":"{{product_id}}"}],"variable":[]}},"response":[{"id":"f4c4802a-9e01-4b1d-9ed7-d046a3f97801","name":"Bought Together","originalRequest":{"method":"GET","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"url":{"raw":"{{domain}}/{{company}}/product/recommendations/bought?customer_id={{customer_id}}&count={{count}}&user_id={{user_id}}&product_id={{product_id}}","host":["{{domain}}"],"path":["{{company}}","product","recommendations","bought"],"query":[{"key":"customer_id","value":"{{customer_id}}"},{"key":"count","value":"{{count}}"},{"key":"user_id","value":"{{user_id}}","description":"the offset, for quasi-pagination"},{"key":"product_id","value":"{{product_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.1"},{"key":"Date","value":"Wed, 06 Jul 2022 12:12:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,User-Agent,X-User-ID,X-Company,X-Api-Key,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,X-Proton-Beta,X-Proton-Frontend-Beta,X-Client-Platform,X-Transaction-ID"},{"key":"Access-Control-Expose-Headers","value":"Content-Length,Content-Range"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": [\n {\n \"product_id\": \"ABC\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"DEF\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"GHI\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"JKL\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"MNO\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n }\n ],\n \"product_id\": [\n \"{{product_id}}\"\n ],\n \"customer_id\": [\n \"{{customer_id}}\"\n ],\n \"count\": [\n \"{{count}}\"\n ],\n \"user_id\": [\n \"{{user_id}}\"\n ]\n}"}],"_postman_id":"bd1a3af4-b48b-411c-846c-32c0ea4fcf6e"},{"name":"Similar Items","id":"54b796e7-9aa1-477d-9a31-2abf282dc69d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"url":"{{domain}}/{{company}}/product/recommendations/similar?product_id={{product_id}}&customer_id={{customer_id}}&count={{count}}&user_id={{user_id}}","description":"Recommends products that are similar to the input product. Proton uses Natural Language Processing (NLP) to match products that contain similar name, descriptions, specifications etc.
\n","urlObject":{"path":["{{company}}","product","recommendations","similar"],"host":["{{domain}}"],"query":[{"description":{"content":"{{product_id_description}}
\n","type":"text/plain"},"key":"product_id","value":"{{product_id}}"},{"description":{"content":"{{customer_id_description}}
\n","type":"text/plain"},"key":"customer_id","value":"{{customer_id}}"},{"description":{"content":"{{count_description}}
\n","type":"text/plain"},"key":"count","value":"{{count}}"},{"description":{"content":"{{user_id}}
\n","type":"text/plain"},"key":"user_id","value":"{{user_id}}"}],"variable":[]}},"response":[{"id":"b548c84d-3fd7-46c9-b6f1-5940e8ba7cab","name":"Similar Items","originalRequest":{"method":"GET","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"url":{"raw":"{{domain}}/{{company}}/product/recommendations/similar?product_id={{product_id}}&customer_id={{customer_id}}&count={{count}}&user_id={{user_id}}","host":["{{domain}}"],"path":["{{company}}","product","recommendations","similar"],"query":[{"key":"product_id","value":"{{product_id}}"},{"key":"customer_id","value":"{{customer_id}}"},{"key":"count","value":"{{count}}"},{"key":"user_id","value":"{{user_id}}","description":"the offset, for quasi-pagination"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.1"},{"key":"Date","value":"Wed, 06 Jul 2022 12:12:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,User-Agent,X-User-ID,X-Company,X-Api-Key,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,X-Proton-Beta,X-Proton-Frontend-Beta,X-Client-Platform,X-Transaction-ID"},{"key":"Access-Control-Expose-Headers","value":"Content-Length,Content-Range"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": [\n {\n \"product_id\": \"ABC\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"DEF\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"GHI\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"JKL\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"MNO\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n }\n ],\n \"product_id\": [\n \"{{product_id}}\"\n ],\n \"customer_id\": [\n \"{{customer_id}}\"\n ],\n \"count\": [\n \"{{count}}\"\n ],\n \"user_id\": [\n \"{{user_id}}\"\n ]\n}"}],"_postman_id":"54b796e7-9aa1-477d-9a31-2abf282dc69d"},{"name":"Recently Viewed Recommendations","id":"9a17763e-d198-4350-a115-51cfaac65512","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"url":"{{domain}}/{{company}}/product/recommendations/recent?customer_id={{customer_id}}&count={{count}}&user_id={{user_id}}","description":"Shows products that the account has recently visited. This recommendation is powered through the Track - Product View Tracking API. No logic/AI is involved in this recommendation.
\n","urlObject":{"path":["{{company}}","product","recommendations","recent"],"host":["{{domain}}"],"query":[{"description":{"content":"{{customer_id_description}}
\n","type":"text/plain"},"key":"customer_id","value":"{{customer_id}}"},{"description":{"content":"{{count_description}}
\n","type":"text/plain"},"key":"count","value":"{{count}}"},{"description":{"content":"{{user_id_description}}
\n","type":"text/plain"},"key":"user_id","value":"{{user_id}}"}],"variable":[]}},"response":[{"id":"3490811e-5229-4c22-baa8-07d5ac652515","name":"Bought Together Copy","originalRequest":{"method":"GET","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"url":{"raw":"{{domain}}/{{company}}/product/recommendations/recent?customer_id={{customer_id}}&count={{count}}&user_id={{user_id}}","host":["{{domain}}"],"path":["{{company}}","product","recommendations","recent"],"query":[{"key":"customer_id","value":"{{customer_id}}"},{"key":"count","value":"{{count}}"},{"key":"user_id","value":"{{user_id}}","description":"the offset, for quasi-pagination"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.1"},{"key":"Date","value":"Wed, 06 Jul 2022 12:12:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"DNT,User-Agent,X-User-ID,X-Company,X-Api-Key,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,X-Proton-Beta,X-Proton-Frontend-Beta,X-Client-Platform,X-Transaction-ID"},{"key":"Access-Control-Expose-Headers","value":"Content-Length,Content-Range"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": [\n {\n \"product_id\": \"ABC\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"DEF\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"GHI\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"JKL\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n },\n {\n \"product_id\": \"MNO\",\n \"name\": \"Apple iPad\",\n \"product_super_category\": \"Miscellaneous\",\n \"product_category\": \"Test Category\",\n \"manufacturer\": \"Test Manufacturer\",\n \"description\": \"This is a test\",\n \"image_url\": \"https://proton.ai/lib_GtGPpbKCmmxDoqOm/dpswabrsvcb9qu4g.png?w=376\",\n \"url\": \"https://proton.ai/\"\n }\n ],\n \"product_id\": [\n \"{{product_id}}\"\n ],\n \"customer_id\": [\n \"{{customer_id}}\"\n ],\n \"count\": [\n \"{{count}}\"\n ],\n \"user_id\": [\n \"{{user_id}}\"\n ]\n}"}],"_postman_id":"9a17763e-d198-4350-a115-51cfaac65512"},{"name":"Complete Cart Recommendations","id":"22a93667-5344-440e-9d37-784ac5a34a43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"body":{"mode":"raw","raw":"{\n \"customer_id\": \"{{customer_id}}\",\n \"user_id\": \"{{user_id}}\", \n \"count\" : \"{{count}}\",\n \"products\": [\n {\"product_id\": \"{{product_id}}\", \"quantity\": \"719\"},\n {\"product_id\": \"{{product_id2}}\", \"quantity\": \"221\"}\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/product/recommendations/cart","description":"Recommends items that fit the cart. The model works by looking at all historical \"carts\" (based on order history) and tries to predict what products are \"missing\" from the current user's cart.
\nThe Recommendations use transactional data exchanged with Proton to determine the best suggestion for the current context. All recommendation endpoints return a JSON array of product info blobs that can be used to populate the screen. (they contain name, price, image_url, description along with any other needed and available field.)
\n","_postman_id":"5be5bd8e-4592-4056-b78e-86811e741ee1"},{"name":"Tracking","item":[{"name":"Track - Product View","id":"8a97b4bc-8686-48aa-b796-02692e57c97b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"body":{"mode":"raw","raw":"{\n \"company\": \"{{company}}\",\n \"event\": \"seen\",\n \"product_id\": \"{{product_id}}\",\n \"customer_id\": \"{{customer_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/track","description":"Registers an event when a user lands on a product page.
\nUsercase:
\n\n\n","urlObject":{"path":["{{company}}","track"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a97b4bc-8686-48aa-b796-02692e57c97b"},{"name":"Track - Product Click","id":"18a0ba0c-b9fe-4550-8326-29e187a0e3cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"body":{"mode":"raw","raw":"{\n \"company\": \"{{company}}\",\n \"event\": \"click\",\n \"product_id\": \"{{product_id}}\",\n \"customer_id\": \"{{customer_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/track","description":"On https://shop.{{company}}.com customer \"{{customer_id}}\" landed on the product details page for product \"{{product_id}}\"
\n
Registers an event when a user clicks on a product.
\nUsercase:
\n\n\n","urlObject":{"path":["{{company}}","track"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"18a0ba0c-b9fe-4550-8326-29e187a0e3cd"},{"name":"Track - Product Click (recommended by Proton)","id":"4fcd404d-d379-4f14-9b1b-474ec9db0faa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"body":{"mode":"raw","raw":"{\n \"company\": \"{{company}}\",\n \"event\": \"click\",\n \"model\": \"similar\",\n \"product_id\": \"{{product_id}}\",\n \"customer_id\": \"{{customer_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/track","description":"On https://shop.{{company}}.com customer \"{{customer_id}}\" clicked product with ID \"{{product_id}}\"
\n
Registers an event when a user clicks on a product that came from a Proton recommendation.
\nUsercase:
\n\n\n","urlObject":{"path":["{{company}}","track"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4fcd404d-d379-4f14-9b1b-474ec9db0faa"},{"name":"Track - Product Add-To-Cart","id":"69a57956-9552-4b19-a79d-aa0bec18870c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"body":{"mode":"raw","raw":"{\n \"company\": \"{{company}}\",\n \"event\": \"add_cart\",\n \"product_id\": \"{{product_id}}\",\n \"customer_id\": \"{{customer_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/track","description":"On https://shop.{{company}}.com customer \"{{customer_id}}\" clicked product with ID \"{{product_id}}\". Product {{product_id}} was recommended by Proton's \"/product/recommendations/similar\" endpoint
\n
Registers an event when a user adds to cart a product.
\nUsercase:
\n\n\n","urlObject":{"path":["{{company}}","track"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"69a57956-9552-4b19-a79d-aa0bec18870c"},{"name":"Track - Product Add-To-Cart (recommended by Proton)","id":"c5ccbe00-4259-4ff1-97c8-87b390c1f2a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"body":{"mode":"raw","raw":"{\n \"company\": \"{{company}}\",\n \"event\": \"add_cart\",\n \"model\": \"periodic\",\n \"product_id\": \"{{product_id}}\",\n \"customer_id\": \"{{customer_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/track","description":"On https://shop.{{company}}.com customer \"{{customer_id}}\" added to their cart product with ID \"{{product_id}}\".
\n
Registers an event when a user adds to cart a product that came from a Proton recommendation.
\nUsercase:
\n\n\n","urlObject":{"path":["{{company}}","track"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5ccbe00-4259-4ff1-97c8-87b390c1f2a0"},{"name":"Track - Product Search","id":"05f8efcb-e958-493d-b7f3-73e01ccf8ea3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"body":{"mode":"raw","raw":"{\n \"company\": \"{{company}}\",\n \"event\": \"search\",\n \"customer_id\": \"{{customer_id}}\",\n \"queryString\": \"red apples\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/track","description":"On https://shop.{{company}}.com customer \"{{customer_id}}\" added to their cart product with ID \"{{product_id}}\". Product \"{{product_id}}\" was recommended by Proton's \"/product/recommendations/periodic\" endpoint
\n
Registers an event when a user submits a search query.
\nUsercase:
\n\n\n","urlObject":{"path":["{{company}}","track"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"05f8efcb-e958-493d-b7f3-73e01ccf8ea3"},{"name":"Track - Login","id":"e9cc0e68-1334-4ad3-97ee-5c6abcf98f32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"body":{"mode":"raw","raw":"{\n \"company\": \"{{company}}\",\n \"old_customer_id\": \"{{customer_id2}}\",\n \"new_customer_id\": \"{{customer_id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/track/login","description":"On https://shop.{{company}}.com customer \"{{customer_id}}\" searches for \"red apples.\"
\n
Identifies a previously anonymous user.
\nUsercase:
\n\n\n","urlObject":{"path":["{{company}}","track","login"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9cc0e68-1334-4ad3-97ee-5c6abcf98f32"}],"id":"22cfc7e2-9cd9-4e22-9d12-d0a03c995874","description":"On https://shop.{{company}}.com customer \"{{customer_id2}}\" logs in and gets assigned a new identifier \"{{customer_id}}\"\"
\n
The Tracking APIs are available for an eCommerce use-case to be called to track user actions on the website (product-views, clicks, searches, add-to-carts) that's used to
\nPersonalize and influence recommendations
\nPower additional endpoints e.g. \"Recently Viewed\"
\nProvide visibility to your sales reps teams using the Desktop/Mobile solution so that they can follow up with customers based on e-commerce activity (e.g. recently added to cart but hasn't bought)
\nfield_id is optional. If left out, the system will generate a globally unique field_id for you.
field_id is required. Every other parameter is optional*.
*If you change the custom field's type to dropdown, then options will also be a required parameter.
To retrieve all custom fields, either pass records as an empty list or leave it out altogether.
Type of records (leave empty for all)
\n","type":"text/plain"},"key":"record_types","value":"customer,contact"}],"variable":[]}},"response":[{"id":"28e1db5a-938b-47df-913b-21f842b161cb","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{domain}}/{{company}}/custom_field/all?record_types=Defines the configuration settings for custom fields stored in a specific index, primarily used for creating and modifying custom fields across enabled record types such as contact, customer, and opportunity.
\ncustom_field_id (str): Automatically generated unique identifier for the custom field, using UUID v4. Can also be given.
display_name (str): Human-readable name for the custom field.
display_description (str): Description of the custom field to provide more context.
field_type (str): Type of the custom field. Valid types currently include \"dropdown\", \"number\", \"boolean\", \"string\".
options (Optional[List[str]]): List of options, required if the field_type is \"dropdown\".
required (bool): Specifies whether the field is mandatory.
record_types (List[str]): Types of records that can have this custom field. Currently enabled types are \"contact\", \"customer\", \"opportunity\".
editability (List[str]): Specifies who can edit the field.
visibility (List[str]): Specifies who can view the field.
config (dict): Configuration for this type of custom field.
Represents an individual instance of a custom field, as it would appear in the custom_fields list of various record types like contacts, customers, and opportunities.
custom_field_id (str): Unique identifier for the custom field associated with this instance.
value (bool,str,float,int, List[str]): The value of the custom field.
We think of an opportunity which could be in serveral possible discreet stages as defined initially.
\npipeline_id: The uid of the pipline in which this opportunity gets created.stage_id: The id of the stage in which this opportunity is created.title : Title of the opportunityowner : List of user ids (generally emails) for the owners of the opportunitiescustomer_id : Customer or Account id for which this opportunity is meant to becontact_id: The id of the contact associated with this opportunityvalue: Dollar value of the opportunityassociations: We can associate products or tasks to an opportunity. Use type : \"product\" to associate a product to this opportunity{\n \"pipeline_id\": \"123456\",\n \"stage_id\": \"stage_3\",\n \"title\": \"New Product Launch\",\n \"owner\": [\"user_101\", \"user_102\"],\n \"customer_id\": \"cust_456789\",\n \"contact_id\": \"cont_789012\",\n \"value\": 50000.00, \n \"created_from_sales_play\": true,\n \"custom_fields\": [\n {\n \"custom_field_id\": \"cf_123\",\n \"value\": \"Option 1\"\n }\n ],\n \"associations\": [\n {\"type\": \"product\", \"product_id\": \"abc123\"}\n ],\n \"groupings\": [\n {\"field\": \"product_super_category\", \"value\": \"Electronics\"},\n {\"field\": \"manufacturer\", \"value\": \"TechCorp\"}\n ]\n}\n\nMany fields in the response are similar to that of the request just repeated. Below are the important ones.
\ndata.opportunity_id: The uid of the newly created opportunitystatus_message: Has to be \"SUCCESS\" to consider this a successful API call{\n \"status_message\": \"SUCCESS\",\n \"data\": {\n \"opportunity_id\": \"opp_654321\",\n \"pipeline_id\": \"123456\",\n \"stage_id\": \"stage_3\",\n \"title\": \"New Product Launch\",\n \"owner\": [\n \"user_101\",\n \"user_102\"\n ],\n \"customer_id\": \"cust_456789\",\n \"customer_info\": null,\n \"contact_id\": \"cont_789012\",\n \"contact_info\": null,\n \"value\": 50000,\n \"closed\": false,\n \"created_by\": \"user_101\",\n \"created_date\": \"2023-04-15T12:00:00Z\",\n \"created_from_sales_play\": true,\n \"last_stage_change_date\": \"2023-04-15T12:00:00Z\",\n \"last_updated_by\": \"user_101\",\n \"last_update_date\": \"2023-04-15T12:00:00Z\",\n \"last_contact_date\": null,\n \"custom_fields\": [\n {\n \"custom_field_id\": \"cf_123\",\n \"value\": \"Option 1\"\n }\n ],\n \"associations\": [\n {\n \"type\": \"product\",\n \"product_id\": \"abc123\"\n }\n ],\n \"groupings\": [\n {\n \"field\": \"product_super_category\",\n \"value\": \"Electronics\"\n },\n {\n \"field\": \"manufacturer\",\n \"value\": \"TechCorp\"\n }\n ],\n \"visibility_ids\": [\n \"vis_123\",\n \"vis_456\"\n ],\n \"is_deleted\": false,\n \"deleted_date\": null\n }\n}\n\nMode of the interactions to include in the activity feed
\n","type":"text/plain"},"key":"mode","value":"order|phone|website|quote|email|task|opportunity"},{"disabled":true,"description":{"content":"Start date (in epoch time) of the activity feed
\n","type":"text/plain"},"key":"start_date","value":"1715140800"},{"disabled":true,"description":{"content":"End date (in epoch time) of the activity feed
\n","type":"text/plain"},"key":"end_date","value":"1717041600"},{"disabled":true,"description":{"content":"Quote or Order ID to filter the activity feed by
\n","type":"text/plain"},"key":"order_id","value":"80181351-01"},{"disabled":true,"description":{"content":"Product ID to filter the activity feed by
\n","type":"text/plain"},"key":"product_id","value":"SF-1350E"},{"disabled":true,"description":{"content":"Product Super Category to filter the activity feed by
\n","type":"text/plain"},"key":"product_super_category","value":"Safety"},{"disabled":true,"description":{"content":"Manufacturer to filter the activity feed by
\n","type":"text/plain"},"key":"manufacturer","value":"3M COMPANY"},{"disabled":true,"description":{"content":"Cursor provided by the response, used to paginate results
\n","type":"text/plain"},"key":"cursor","value":"[1692892800000, \"quote_80549814-00\"]"},{"disabled":true,"description":{"content":"Number of activities to return in the response
\n","type":"text/plain"},"key":"count","value":"50"},{"disabled":true,"description":{"content":"Sort order of activities by date
\n","type":"text/plain"},"key":"sort","value":"asc"}],"variable":[]}},"response":[{"id":"7a7d111e-21a8-47df-a6af-67c78950da74","name":"Get Opportunity Activity Feed","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-User-Id","value":"{{user_id}}"},{"key":"X-Company","value":"{{company}}"},{"key":"X-Api-Key","value":"{{api_key}}"}],"url":"{{domain}}/{{company}}/opportunities/{opportunity_id}/activity_feed"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status_message\": \"SUCCESS\",\r\n \"data\": {\r\n \"activities\": [\r\n {\r\n \"date\": \"2024-03-12T16:31:34.486552Z\",\r\n \"activity_id\": \"audit_2scwmyhYfeeJ7Zaa5UbgXa\",\r\n ...\r\n },\r\n {\r\n \"date\": \"2024-03-12T16:31:15.963186Z\",\r\n \"activity_id\": \"task_96c083e4-2811-4172-9442-3183026d58e7\",\r\n ...\r\n }\r\n ],\r\n \"cursor\": null\r\n }\r\n}"}],"_postman_id":"536ad8d9-1816-4cd4-8de5-2e7b67b571be"},{"name":"Search Opportunities","id":"065481bf-0391-4464-9366-73e8a5f66fac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-User-Id","value":"{{user_id}}","type":"text"},{"key":"X-Company","value":"{{company}}","type":"text"},{"key":"X-Api-Key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/opportunities/search","description":"The search route allows users to query opportunities based on various attributes using a structured filtering syntax. Each attribute can be filtered using specific operators that act on the values of the fields within an opportunity. The operators define conditions such as equality, inequality, containment, and comparisons.
\nQueries are constructed as JSON objects where each key corresponds to an opportunity attribute, and the value is another JSON object specifying the filter criteria for that attribute. The filter object may contain one or more operators, each paired with a list of operands that must align with the data type appropriate for the operator.
\neq (equals): Accepts strings, booleans, floats, and timestamps. It checks for exact matches.
neq (does not equal): Also accepts strings, booleans, floats, and timestamps, checking for any value that does not match the operand.
gt (greater than) and gte (greater than or equal to): These operate on floats and timestamps, useful for finding values above a certain number or date.
lt (less than) and lte (less than or equal to): Similar to gt/gte, but for values below a certain threshold.
contains : Specifically for strings or arrays, this operator searches for fields that include the operand within them.
not_contains : Opposite of contains, looking for fields that do not include the specified substring.
For custom fields, the custom_field_id operator must be used within the custom_fields parameter to specify which custom field is being targeted by the query.
For inherited fields, the inherited_field_id and inherit_from operators must be used within the inherited_fields parameter to specify which inherited field and record type, respectively, is being targeted by the query. Currently, inherited fields only support customer and product record types, and only support the eq comparison operator.
{\n \"title\": {\n \"contains\": [\"Launch\"]\n },\n \"value\": {\n \"gte\": [50000.00],\n \"lt\": [100000.00]\n },\n \"created_date\": {\n \"gte\": [\"2023-01-01T00:00:00Z\"],\n \"lt\": [\"2023-12-31T23:59:59Z\"]\n },\n \"custom_fields\": [\n {\n \"custom_field_id\": \"cf_123\",\n \"eq\": [\"High Priority\"]\n }\n ],\n \"inherited_fields\": [\n {\n \"inherited_field_id\": \"branch\",\n \"inherit_from\": \"customer\",\n \"eq\": [\"1010\"]\n },\n {\n \"inherited_field_id\": \"product_super_category\",\n \"inherit_from\": \"product\",\n \"eq\": [\"Alcohol Wipes\"]\n }\n ]\n}\n\nSyntactical Errors: If a filter uses an incorrect operator for a given type (e.g., gt with a string), the API will return an error.
Logical Consistency: While the API accepts filters that are syntactically correct even if they are logically contradictory (e.g., eq and neq with the same operand), such filters will not produce results but will not return an error.
The search route allows users to query opportunities based on various attributes using a structured filtering syntax. Each attribute can be filtered using specific operators that act on the values of the fields within an opportunity. The operators define conditions such as equality, inequality, containment, and comparisons.
\nQueries are constructed as JSON objects where each key corresponds to an opportunity attribute, and the value is another JSON object specifying the filter criteria for that attribute. The filter object may contain one or more operators, each paired with a list of operands that must align with the data type appropriate for the operator.
\neq (equals): Accepts strings, booleans, floats, and timestamps. It checks for exact matches.
neq (does not equal): Also accepts strings, booleans, floats, and timestamps, checking for any value that does not match the operand.
gt (greater than) and gte (greater than or equal to): These operate on floats and timestamps, useful for finding values above a certain number or date.
lt (less than) and lte (less than or equal to): Similar to gt/gte, but for values below a certain threshold.
contains : Specifically for strings or arrays, this operator searches for fields that include the operand within them.
not_contains : Opposite of contains, looking for fields that do not include the specified substring.
For custom fields, the custom_field_id operator must be used within the custom_fields parameter to specify which custom field is being targeted by the query.
For inherited fields, the inherited_field_id and inherit_from operators must be used within the inherited_fields parameter to specify which inherited field and record type, respectively, is being targeted by the query. Currently, inherited fields only support customer and product record types, and only support the eq comparison operator.
{\n \"title\": {\n \"contains\": [\"Launch\"]\n },\n \"value\": {\n \"gte\": [50000.00],\n \"lt\": [100000.00]\n },\n \"created_date\": {\n \"gte\": [\"2023-01-01T00:00:00Z\"],\n \"lt\": [\"2023-12-31T23:59:59Z\"]\n },\n \"custom_fields\": [\n {\n \"custom_field_id\": \"cf_123\",\n \"eq\": [\"High Priority\"]\n }\n ],\n \"inherited_fields\": [\n {\n \"inherited_field_id\": \"branch\",\n \"inherit_from\": \"customer\",\n \"eq\": [\"1010\"]\n },\n {\n \"inherited_field_id\": \"product_super_category\",\n \"inherit_from\": \"product\",\n \"eq\": [\"Alcohol Wipes\"]\n }\n ]\n}\n\nSyntactical Errors: If a filter uses an incorrect operator for a given type (e.g., gt with a string), the API will return an error.
Logical Consistency: While the API accepts filters that are syntactically correct even if they are logically contradictory (e.g., eq and neq with the same operand), such filters will not produce results but will not return an error.
Given a search query (like the /search endpoint), this API endpoint calculates and returns the total count, total value, and forecasted value of opportunities within a specific pipeline and satisfying the search query. The calculation takes into account the stages of opportunities and their respective probabilities of closing.
Given a search query (like the /search endpoint), this API endpoint calculates and returns the total count, total value, and forecasted value of opportunities for all pipelines and satisfying the search query. The calculation takes into account the stages of opportunities and their respective probabilities of closing. A pipeline_id filter can be added to narrow the results.
Total Count: The aggregate number of opportunities within the pipeline.
\nTotal Value: The total financial value of the pipeline.
\nForecast Value: A predictive metric estimating potential revenue from the current opportunities, weighting each opportunity's value by its stage's assigned probability.
\nQuery string to search on mockable users
\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"Whether to return only active users
\n","type":"text/plain"},"key":"active_only","value":"false"},{"disabled":true,"description":{"content":"Number of users to return
\n","type":"text/plain"},"key":"count","value":"10"},{"disabled":true,"description":{"content":"Paginated offset to return count from
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"e82e3f4a-8648-44ca-9583-f9faceff31e3","name":"Get Pipeline Mockable Users","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-User-Id","value":"{{user_id}}"},{"key":"X-Company","value":"{{company}}"},{"key":"X-Api-Key","value":"{{api_key}}"}],"url":{"raw":"{{domain}}/{{company}}/pipelines/{pipeline_id}/mock_users?q=proton&active_only=true","host":["{{domain}}"],"path":["{{company}}","pipelines","{pipeline_id}","mock_users"],"query":[{"key":"q","value":"proton","description":"Query string to search on mockable users","type":"text"},{"key":"active_only","value":"true","description":"Whether to return only active users","type":"text"},{"key":"count","value":"10","description":"Number of users to return","type":"text","disabled":true},{"key":"offset","value":"0","description":"Paginated offset to return count from","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": [\n {\n \"user_id\": \"protontestaccount@aquiferdist.com\",\n \"display_name\": \"Proton Test\",\n \"email\": \"protontestaccount@aquiferdist.com\",\n \"name\": \"Proton Test\"\n },\n {\n \"user_id\": \"protontestaccount2@aquiferdist.com\",\n \"name\": \"Proton Test\",\n \"email\": \"protontestaccount2@aquiferdist.com\"\n }\n ],\n \"q\": [\n \"proton\"\n ],\n \"active_only\": [\n \"false\"\n ]\n}"}],"_postman_id":"51f684e1-24fc-4c67-9ae7-fe672cd741e7"}],"id":"b4fd9705-b9f6-4a40-a673-0c5f92cae695","description":"Represents the core structure and definition of an Opportunity within the system, encapsulating all key attributes necessary for identifying and managing sales opportunities.
\nopportunity_id (str): Unique identifier for the opportunity.
pipeline_id (str): Identifier for the pipeline associated with this opportunity.
stage_id (str): Identifier for the current stage of the opportunity within the pipeline.
title (str): Title of the opportunity.
owner (List[str]): List of user IDs who own or manage the opportunity.
customer_id (str): Identifier for the customer associated with the opportunity.
customer_info (Optional[dict]): Dictionary containing additional information about the customer. Populated if customer_id was found in the system.
contact_id (Optional[str]): Identifier for the primary contact associated with this opportunity.
contact_info (Optional[dict]): Dictionary containing additional information about the contact. Populated if contact_id was found in the system.
value (float): Financial value of the opportunity.
closed (bool): Indicates whether the opportunity is in a closed stage.
created_by (str): User ID of the person who created the opportunity.
created_date (datetime): Date and time when the opportunity was created.
created_from_sales_play (bool): Indicates whether the opportunity was created as a result of a sales play.
last_stage_change_date (datetime): Date and time when the opportunity last moved to a new stage.
last_updated_by (str): User ID of the person who last updated the opportunity.
last_update_date (datetime): Date and time when the opportunity was last updated.
last_contact_date (Optional[datetime]): Date and time when the last contact was made with the customer or contact associated with this opportunity.
custom_fields (List[CustomFieldInstance]): List of custom field instances associated with the opportunity.
associations (List[dict]): List of associated entities or items related to the opportunity.
groupings (List[dict]): List of groupings that categorize the opportunity.
visibility_ids (List[str]): List of IDs defining who can view this opportunity.
is_deleted (bool): Indicates whether the opportunity is soft-deleted.
deleted_date (Optional[datetime]): Date and time when the opportunity was deleted, if applicable.
The custom_fields attribute requires the definition of CustomFieldInstance, which holds the structure for any custom field associated with an opportunity and is defined above.
Soft-deleted opportunities remain in the database and can be restored or permanently removed based on system policy.
\nThe Get Customer API v1 endpoint allows you to retrieve a single customer record by its business identifier or internal UUID. The response returns the full customer record including core fields, billing hierarchy, enriched representative and account group data, custom fields, and analytics. Customers represent the accounts your sales team sells to, including their identifying information, address details, contact info, and classification data.
\nMethod: GET\nURL: {{domain}}/{{company}}/v1/customers/{{identifier}}
GET {{domain}}/acme/v1/customers/CUST-001\nNo request body is required for this endpoint.
\n{\n \"status_message\": \"success\",\n \"data\": {\n \"customer_id\": \"CUST-001\",\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Acme Corporation\",\n \"bill_to_id\": \"BT-100\",\n \"is_bill_to\": false,\n \"street_address\": \"123 Main St\",\n \"street_address_2\": null,\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip_code\": \"94105\",\n \"country\": \"US\",\n \"region\": \"Pacific\",\n \"branch\": \"West Coast\",\n \"location\": null,\n \"coordinate\": null,\n \"email\": \"info@acmecorp.com\",\n \"office_phone_number\": \"+1-555-0100\",\n \"fax_number\": null,\n \"is_active\": true,\n \"type\": \"distributor\",\n \"source\": \"ERP\",\n \"representative_ids\": [\"rep-001\", \"rep-002\"],\n \"representatives\": [\n {\n \"user_id\": \"rep-001\",\n \"name\": \"Jane Smith\",\n \"email\": \"jane.smith@company.com\",\n \"internal_user_id\": \"int-001\"\n },\n {\n \"user_id\": \"rep-002\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@company.com\",\n \"internal_user_id\": \"int-002\"\n }\n ],\n \"visibility_ids\": [\"group-001\"],\n \"account_groups\": [\n {\n \"account_group_id\": \"group-001\",\n \"name\": \"West Coast Team\"\n }\n ],\n \"bill_to\": {\n \"customer_id\": \"BT-100\",\n \"name\": \"Acme National\"\n },\n \"ship_tos\": null,\n \"parent_customer_id\": null,\n \"account_type\": \"ship_to\",\n \"parent\": null,\n \"children\": null,\n \"custom_fields\": [\n {\n \"custom_field_id\": \"cf-industry\",\n \"value\": \"Manufacturing\",\n \"display_value\": { \"en\": \"Manufacturing\" }\n }\n ],\n \"notepad\": \"Key account - handle with care\",\n \"last_contact_date\": \"2024-03-15T10:30:00Z\",\n \"last_purchase_date\": \"2024-02-20T14:00:00Z\",\n \"last_ingested_date\": \"2024-03-10T08:00:00Z\",\n \"total_spending\": 150000.00,\n \"y2d_spending\": 45000.00,\n \"last_year_spending\": 120000.00,\n \"previous_year_spending\": 95000.00,\n \"m2d_spending\": 12000.00,\n \"last_year_m2d_spending\": 10000.00,\n \"average_order_value\": 5000.00,\n \"gross_margin_last_year\": 36000.00,\n \"YOY\": 26.3,\n \"YOY_dollars\": 25000.00,\n \"YOY_Y2D\": 15.4,\n \"YOY_Y2D_dollars\": 6000.00,\n \"proton_score\": 85.5,\n \"proton_score_explanation\": \"High-value customer with consistent growth\",\n \"churn_probability\": 0.12,\n \"churn_status\": \"low_risk\",\n \"churn_explanation\": \"Regular purchasing pattern with recent activity\",\n \"opportunities_count\": 3,\n \"total_last_year_orders\": 24,\n \"orders_per_week\": 0.46,\n \"return_rate\": 2.1,\n \"product_lines_purchased\": 5,\n \"product_lines_purchased_percent\": 45.5,\n \"n_shiptos\": 0,\n \"external_id\": null,\n \"lead\": null,\n \"lead_id\": null,\n \"is_lead\": false\n }\n}\n\nThe response returns the complete customer record. Fields are grouped by category below. All fields are nullable unless noted otherwise.
\nRepresentative object structure:
\nAccount group object structure:
\nReturned when authentication fails or the API key is invalid or missing.
\nReturned when the requesting user does not have visibility access to the customer.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"FORBIDDEN\",\n \"message\": \"User does not have access to this customer\"\n }\n}\n\nReturned when no customer is found with the provided identifier.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"Customer not found\"\n }\n}\n\nReturned when an unexpected error occurs on the server.
\nUse the right identifier: You can use either the business customer_id or the internal UUID — both work interchangeably
Cache the UUID: The internal id (UUID) is stable and ideal for caching and cross-referencing
Check enriched fields: The response includes enriched representatives and account_groups objects — use these instead of resolving IDs manually
Handle null fields: Most fields are nullable — always check for null values before processing
\nError handling: Check for 403 (access denied) and 404 (not found) responses and handle them appropriately
\nThe response returns the complete customer record with all available fields, including analytics and scoring data
\nRepresentative and account group data is automatically enriched — representatives contains full user details resolved from representative_ids
For bill-to accounts, the ship_tos array is populated with child ship-to customers
For ship-to accounts, the bill_to object is populated with the parent bill-to customer
Custom fields are returned in unpacked format with display values
\nIf the identifier matches a lead record, the lead data is included in the response
\nAccess control is enforced — the requesting user must belong to at least one of the customer's visibility account groups
\nThe Update Customer API v1 endpoint allows you to partially update an existing customer record within a specific company. This endpoint uses PATCH semantics — only fields explicitly included in the request body are updated, while omitted fields remain unchanged. Fields sent with a null value are cleared. Customers represent the accounts your sales team sells to, including their identifying information, address details, contact info, and classification data.
Method: PATCH\nURL: {{domain}}/{{company}}/v1/customers/{{identifier}}
{\n \"field_name\": \"new_value\"\n}\n\nOnly include the fields you want to update. All fields are optional — omit a field to leave it unchanged, or send null to clear it.
When updating custom fields, send the full desired list. The provided list replaces the existing custom fields entirely. Omit the field to leave custom fields unchanged.
\n{\n \"custom_fields\": [\n {\n \"custom_field_id\": \"cf-12345\",\n \"value\": \"some_value\"\n },\n {\n \"custom_field_id\": \"cf-67890\",\n \"value\": [\"option1\", \"option2\"]\n }\n ]\n}\n\n{\n \"name\": \"Acme Corporation (Updated)\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"is_active\": true,\n \"representative_ids\": [\"rep-001\", \"rep-002\"],\n \"custom_fields\": [\n {\n \"custom_field_id\": \"cf-industry\",\n \"value\": \"Manufacturing\"\n }\n ]\n}\n\nThis request will:
\nUpdate the customer name to \"Acme Corporation (Updated)\"
\nChange the city to \"Los Angeles\" and state to \"CA\"
\nSet the customer as active
\nReplace assigned sales representatives with rep-001 and rep-002
\nReplace all custom fields with the single provided custom field
\n{\n \"status_message\": \"success\",\n \"data\": {\n \"customer_id\": \"CUST-001\",\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Acme Corporation (Updated)\",\n \"bill_to_id\": \"BT-100\",\n \"is_bill_to\": false,\n \"street_address\": \"123 Main St\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip_code\": \"94105\",\n \"country\": \"US\",\n \"region\": \"Pacific\",\n \"branch\": \"West Coast\",\n \"email\": \"info@acmecorp.com\",\n \"office_phone_number\": \"+1-555-0100\",\n \"fax_number\": null,\n \"is_active\": true,\n \"type\": \"distributor\",\n \"source\": \"ERP\",\n \"representative_ids\": [\"rep-001\", \"rep-002\"],\n \"visibility_ids\": [\"group-001\"],\n \"custom_fields\": [\n {\n \"custom_field_id\": \"cf-industry\",\n \"value\": \"Manufacturing\",\n \"display_value\": { \"en\": \"Manufacturing\" }\n }\n ],\n \"notepad\": null,\n \"last_contact_date\": \"2024-03-15T10:30:00Z\",\n \"last_purchase_date\": \"2024-02-20T14:00:00Z\",\n \"total_spending\": 150000.00,\n \"y2d_spending\": 45000.00,\n \"last_year_spending\": 120000.00,\n \"proton_score\": 85.5,\n \"opportunities_count\": 3\n }\n}\n\nThe response returns the full updated customer record, including all fields — not just the ones that were modified.
\nThe response includes all customer attributes. Key fields are listed below:
\nReturned when the request body contains no updatable fields or is malformed.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"INVALID_REQUEST\",\n \"message\": \"Invalid request data or no updatable fields provided\"\n }\n}\n\nReturned when authentication fails or the API key is invalid or missing.
\nReturned when the requesting user does not have visibility access to the customer.
\nReturned when no customer is found with the provided identifier.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"Customer not found\"\n }\n}\n\nReturned when an unexpected error occurs on the server.
\nSend only changed fields: Only include fields you want to update — omitted fields are left unchanged
\nUse null to clear fields: Send a field with value null to explicitly clear it
Custom fields are replaced entirely: When updating custom fields, send the complete list — partial updates are not supported for custom fields
\nUse the right identifier: You can use either the business customer_id or the internal UUID in the URL path
Check access first: Ensure the requesting user has visibility access to the customer to avoid 403 errors
\nVerify the response: The response returns the full updated record — use it to confirm your changes were applied correctly
\nThis endpoint uses PATCH semantics — only provided fields are updated
\nThe response always returns the complete customer record, not just the updated fields
\nUpdating a customer automatically creates an audit trail entry
\nA customer.updated webhook event is published after a successful update
The representative_ids and visibility_ids fields replace the entire list when provided — they do not append
Fields not listed in the Updatable Fields table cannot be modified through this endpoint
\nThe Customer Search API v2 endpoint allows you to search for customers within a specific company using a query string and advanced filtering options. This endpoint supports various search operators for flexible and precise customer searches. Customers represent the accounts your sales team sells to, including their identifying information, address details, contact info, and classification data.
\nMethod: POST\nURL: {{domain}}/{{company}}/v2/customers/search
{\n \"query\": \"string\",\n \"filters\": {\n \"field_name\": {\n \"operator\": value\n }\n },\n \"count\": integer,\n \"offset\": integer\n}\n\nThe following fields can be used in the filters object:
Each filter field can use one or more of the following operators:
\nNote:
\nMultiple operators cannot be used for the same field in a single filter
\nAt least one operator must be defined for each filter field
\nOperators can accept single values or arrays (where applicable)
\n{\n \"query\": \"acme\",\n \"filters\": {\n \"state\": { \"eq\": \"CA\" },\n \"city\": { \"contains\": \"Francisco\" },\n \"account_type\": { \"includes\": [\"bill_to\", \"ship_to\"] }\n },\n \"count\": 20,\n \"offset\": 0\n}\n\nThis request will:
\nSearch for customers with names or IDs containing \"acme\"
\nFilter for customers located in California
\nInclude only customers in cities containing \"Francisco\"
\nInclude only customers with account type \"bill_to\" or \"ship_to\"
\n{\n \"status_message\": \"success\",\n \"data\": {\n \"message\": \"\",\n \"items\": [\n {\n \"customer_id\": \"CUST-001\",\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"Acme Corporation\",\n \"bill_to_id\": \"BT-100\",\n \"street_address\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip_code\": \"94105\",\n \"email\": \"info@acmecorp.com\",\n \"office_phone_number\": \"+1-555-0100\",\n \"fax_number\": null,\n \"branch\": \"West Coast\",\n \"region\": \"Pacific\",\n \"country\": \"US\"\n }\n ],\n \"total_count\": 15,\n \"page_size\": 20,\n \"page_number\": 1,\n \"total_pages\": 1\n }\n}\n\nReturned when the request is malformed or contains invalid parameters.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"INVALID_REQUEST\",\n \"message\": \"Invalid request data or search query\"\n }\n}\n\nReturned when authentication fails or the API key is invalid or missing.
\nReturned when the specified company does not exist.
\nReturned when an unexpected error occurs on the server.
\nUse the count and offset parameters to paginate through results:
First page: offset: 0, count: 20
Second page: offset: 20, count: 20
Third page: offset: 40, count: 20
The response includes total_count, page_number, and total_pages to help with pagination navigation.
Use specific queries: Provide at least 3 characters in the query parameter for better performance
Combine filters wisely: Use multiple filters to narrow down results effectively
\nHandle pagination: For large result sets, implement proper pagination to avoid timeouts
\nError handling: Always check the status_message and handle errors appropriately
Account hierarchy: Use account_type and bill_to_id filters to navigate customer hierarchies
The search is case-insensitive for the query parameter
Filter operators are case-sensitive for string comparisons
\nEmpty filter values are treated as \"match any\"
\nThe includes operator is particularly useful for matching against multiple states, regions, or account types
Results are sorted by relevance to the search query by default
\nAll filters are combined using AND logic — all conditions must be met for a customer to be returned
\nThe Create Customer API v1 endpoint allows you to create a new customer record within a specific company. Customers represent the accounts your sales team sells to, including their identifying information, address details, contact info, and classification data. The endpoint validates that the customer_id is unique within the company before creating the record.
Method: POST
URL: {{domain}}/{{company}}/v1/customers
{\n \"customer_id\": \"string\",\n \"name\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"country\": \"string\",\n \"zip_code\": \"string\",\n \"email\": \"string\",\n \"office_phone_number\": \"string\",\n \"fax_number\": \"string\",\n \"is_active\": boolean,\n \"type\": \"string\",\n \"branch\": \"string\",\n \"location\": \"string\",\n \"region\": \"string\",\n \"source\": \"string\",\n \"bill_to_id\": \"string\",\n \"is_bill_to\": boolean,\n \"parent_customer_id\": \"string\",\n \"account_type\": \"string\",\n \"representative_ids\": [\"string\"],\n \"visibility_ids\": [\"string\"],\n \"custom_fields\": [\n {\n \"custom_field_id\": \"string\",\n \"string_val\": \"string\",\n \"float_val\": number,\n \"bool_val\": boolean,\n \"date_val\": \"string\",\n \"string_val_list\": [\"string\"]\n }\n ]\n}\n\nEach custom field object in the custom_fields array has the following structure:
Note: Provide only one value field per custom field object, matching the custom field's defined type.
\n{\n \"customer_id\": \"CUST-001\",\n \"name\": \"Acme Corporation\",\n \"street_address\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"country\": \"USA\",\n \"zip_code\": \"94105\",\n \"email\": \"contact@acme.com\",\n \"is_active\": true,\n \"representative_ids\": [\"rep_101\", \"rep_102\"],\n \"custom_fields\": [\n {\n \"custom_field_id\": \"cf_industry\",\n \"string_val\": \"Technology\"\n },\n {\n \"custom_field_id\": \"cf_annual_revenue\",\n \"float_val\": 5000000.00\n }\n ]\n}\n\nThis request will:
\nCreate a new customer with ID \"CUST-001\" named \"Acme Corporation\"
\nSet the address to 123 Main St, San Francisco, CA 94105, USA
\nSet the email to contact@acme.com
\nMark the customer as active
\nAssign sales representatives rep_101 and rep_102
\nSet two custom fields: industry as \"Technology\" and annual revenue as 5,000,000
\n{\n \"status_message\": \"success\",\n \"data\": {\n \"customer_id\": \"CUST-001\",\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"created\": true\n }\n}\n\nReturned when the request is malformed, missing required fields, or the customer_id already exists.
{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"INVALID_REQUEST\",\n \"message\": \"Customer with customer_id 'CUST-001' already exists.\"\n }\n}\n\nReturned when authentication fails or the API key is invalid or missing.
\nReturned when the specified company does not exist.
\nReturned when an unexpected error occurs on the server.
\nUse meaningful customer IDs: Choose a customer_id format that is consistent and identifiable (e.g., CUST-001, ACC-12345)
Check for duplicates: The customer_id must be unique within a company — the endpoint returns a 400 error if it already exists
Set hierarchy fields together: When creating customers in an account hierarchy, set bill_to_id, account_type, and optionally parent_customer_id together for consistency
Match custom field types: Use the correct value field (string_val, float_val, bool_val, date_val, or string_val_list) that matches the custom field definition
Save the UUID: Store the returned id (UUID) for subsequent API calls — it can be used as the identifier in Get and Update endpoints
The customer_id must be unique within the company — duplicate IDs will be rejected with a 400 error
The is_active field defaults to true if not provided
A customer.created webhook event is published after a successful creation
The returned id is a stable internal UUID that can be used interchangeably with customer_id in other endpoints
Custom fields must reference valid custom field definitions configured for the company
\nDate values in custom fields must use ISO 8601 format (e.g., 2024-01-15 or 2024-01-15T10:30:00Z)
The Bulk Create Customers API v1 endpoint allows you to create multiple customer records in a single request within a specific company. The endpoint processes each item independently — valid items succeed even if others fail, providing per-item error reporting. Customers represent the accounts your sales team sells to, including their identifying information, address details, contact info, and classification data.
\nMethod: POST\nURL: {{domain}}/{{company}}/v1/customers/bulk
{\n \"items\": [\n {\n \"customer_id\": \"string\",\n \"name\": \"string\",\n \"street_address\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"country\": \"string\",\n \"zip_code\": \"string\",\n \"email\": \"string\",\n \"office_phone_number\": \"string\",\n \"fax_number\": \"string\",\n \"is_active\": boolean,\n \"type\": \"string\",\n \"branch\": \"string\",\n \"location\": \"string\",\n \"region\": \"string\",\n \"source\": \"string\",\n \"bill_to_id\": \"string\",\n \"is_bill_to\": boolean,\n \"parent_customer_id\": \"string\",\n \"account_type\": \"string\",\n \"representative_ids\": [\"string\"],\n \"visibility_ids\": [\"string\"],\n \"custom_fields\": [\n {\n \"custom_field_id\": \"string\",\n \"string_val\": \"string\",\n \"float_val\": number,\n \"bool_val\": boolean,\n \"date_val\": \"string\",\n \"string_val_list\": [\"string\"]\n }\n ]\n }\n ]\n}\n\nEach custom field object in the custom_fields array has the following structure:
Note: Provide only one value field per custom field object, matching the custom field's defined type.
\n{\n \"items\": [\n {\n \"customer_id\": \"CUST-001\",\n \"name\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"is_active\": true,\n \"custom_fields\": [\n {\n \"custom_field_id\": \"cf_industry\",\n \"string_val\": \"Technology\"\n },\n {\n \"custom_field_id\": \"cf_annual_revenue\",\n \"float_val\": 5000000.00\n },\n {\n \"custom_field_id\": \"cf_is_enterprise\",\n \"bool_val\": true\n }\n ]\n },\n {\n \"customer_id\": \"CUST-002\",\n \"name\": \"Beta Inc\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"custom_fields\": [\n {\n \"custom_field_id\": \"cf_industry\",\n \"string_val\": \"Manufacturing\"\n }\n ]\n },\n {\n \"customer_id\": \"\",\n \"name\": \"\"\n }\n ]\n}\n\nThis request will:
\nCreate \"Acme Corporation\" (CUST-001) with custom fields for industry, revenue, and enterprise status
\nCreate \"Beta Inc\" (CUST-002) with city, state, and industry custom field
\nFail on the third item because customer_id and name are empty
The response always returns 200 OK, even if some items fail. Check the summary and individual results to determine the outcome of each item.
{\n \"status_message\": \"success\",\n \"data\": {\n \"summary\": {\n \"total\": 3,\n \"successful\": 2,\n \"failed\": 1,\n \"created\": 2,\n \"updated\": 0,\n \"errors\": [\n {\n \"index\": 2,\n \"id\": null,\n \"input\": {\n \"customer_id\": \"\",\n \"name\": \"\"\n },\n \"errors\": [\n {\n \"field\": \"customer_id\",\n \"code\": \"required\",\n \"message\": \"Customer ID is required\",\n \"value\": \"\"\n },\n {\n \"field\": \"name\",\n \"code\": \"required\",\n \"message\": \"Customer name is required\",\n \"value\": \"\"\n }\n ]\n }\n ]\n },\n \"results\": [\n {\n \"index\": 0,\n \"id\": \"CUST-001\",\n \"success\": true,\n \"created\": true\n },\n {\n \"index\": 1,\n \"id\": \"CUST-002\",\n \"success\": true,\n \"created\": true\n },\n {\n \"index\": 2,\n \"id\": null,\n \"success\": false,\n \"errors\": [\n {\n \"field\": \"customer_id\",\n \"code\": \"required\",\n \"message\": \"Customer ID is required\",\n \"value\": \"\"\n },\n {\n \"field\": \"name\",\n \"code\": \"required\",\n \"message\": \"Customer name is required\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n}\n\nEach error in the summary.errors array contains:
Returned when the request structure itself is invalid (e.g., missing items array).
{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"INVALID_REQUEST\",\n \"message\": \"Invalid request data\"\n }\n}\n\nReturned when authentication fails or the API key is invalid or missing.
\nReturned when the items array exceeds the maximum of 1,000 items.
Returned when an unexpected error occurs on the server.
\nThe endpoint processes items in three phases:
\nValidation: Each item is checked for required fields (customer_id, name) and in-batch duplicate customer_id values
Duplicate Check: A single batch query checks which customer_id values already exist in the database
Creation: Valid, non-duplicate items are created individually with webhook events published for each
\nKey behaviors:
\nPartial success: Valid items are created even if other items in the batch fail
\nNon-atomic: There is no rollback — successfully created items remain even if later items fail
\nOrder preserved: Results are returned in the same order as the input items
\nIndependent errors: Each item has its own error tracking, allowing you to identify and retry only failed items
\nStay within limits: Send a maximum of 1,000 items per request
\nEnsure unique IDs: Verify that all customer_id values are unique both within the batch and against existing records
Handle partial failures: Always check both summary.failed and individual results to identify which items need to be retried
Retry only failed items: Use the index and id fields in error responses to identify and resubmit only the items that failed
Match custom field types: Use the correct value field (string_val, float_val, bool_val, date_val, or string_val_list) that matches each custom field's definition
Batch appropriately: For very large imports, split into multiple requests of up to 1,000 items each
\nThe is_active field defaults to true if not provided
A customer.created webhook event is published for each successfully created customer
In-batch duplicates are handled by accepting the first occurrence and rejecting subsequent ones with a duplicate error code
The response always returns HTTP 200, even for partial failures — check the summary for the actual outcome
Custom fields must reference valid custom field definitions configured for the company
\nDate values in custom fields must use ISO 8601 format (e.g., 2024-01-15 or 2024-01-15T10:30:00Z)
Manage customer records within your Proton account. Customers represent the accounts your sales team sells to — each with identifying information, address details, contact info, sales representative assignments, account hierarchy, and custom fields.
\nUse these endpoints to create, retrieve, update, and search customers programmatically.
\n","_postman_id":"c5bbeca6-3e1c-435d-a67b-10c8bfa15585"},{"name":"Quotes","item":[{"name":"Get Quote v2","id":"bc011dd7-ebe1-4150-8ae0-e1dd53f32d3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-User-Id","value":"{{user_id}}","type":"text"},{"key":"X-Company","value":"{{company}}","type":"text"},{"key":"X-Api-Key","value":"{{api_key}}","type":"text"}],"url":"{{domain}}/{{company}}/quotes/{quote_id}","urlObject":{"path":["{{company}}","quotes","{quote_id}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"7c23d19f-ee08-450d-8fb7-17d96f5aa2c4","name":"Get Quote","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-User-Id","value":"{{user_id}}"},{"key":"X-Company","value":"{{company}}"},{"key":"X-Api-Key","value":"{{api_key}}"}],"url":"{{domain}}/{{company}}/v2/quotes/{quote_id}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status_message\": \"SUCCESS\",\r\n \"data\": {\r\n \"quote_id\": \"S100519712.001\",\r\n \"bill_to_id\": \"55\",\r\n \"customer_id\": \"550\",\r\n \"expiration_date\": null,\r\n \"last_ingested_date\": \"2024-11-06T15:56:52.944951\",\r\n \"last_contact_date\": null,\r\n \"associations\": [],\r\n \"contact_id\": null,\r\n \"contact_name\": null,\r\n \"contact_email\": null,\r\n \"status_last_modified\": \"2024-07-13T10:20:28.465750+00:00\",\r\n \"status_erp\": null,\r\n \"status_rep\": null,\r\n \"status\": \"open\",\r\n \"n_days_from_quote_to_order\": 0.0,\r\n \"total_value\": 6345.582699,\r\n \"remaining_value\": 6345.582699,\r\n \"realized_value\": 0.0,\r\n \"num_quote_lines\": 1.0,\r\n \"num_purchased_quote_lines\": 0.0,\r\n \"source\": \"erp\",\r\n \"total_value_initial\": 6345.582699,\r\n \"total_value_last_modified\": \"2024-08-10T10:14:23.290107+00:00\",\r\n \"manufacturer\": \"\",\r\n \"quantity_total\": 48,\r\n \"custom_fields\": [\r\n {\r\n \"custom_field_id\": \"custom_quote_branch_header\",\r\n \"value\": \"WEST\"\r\n },\r\n {\r\n \"custom_field_id\": \"custom_quote_ordered_by_header\",\r\n \"value\": \"Mark Johnson\"\r\n },\r\n {\r\n \"custom_field_id\": \"custom_quote_writer_header\",\r\n \"value\": \"SMITHJ\"\r\n },\r\n {\r\n \"custom_field_id\": \"custom_quote_margin_perc_header\",\r\n \"value\": \"31.43%\"\r\n },\r\n {\r\n \"custom_field_id\": \"custom_quote_shipping_notes_header\",\r\n \"value\": \"ALLOW 4-6 WEEKS DELIVER JUST TO BE SAFE.\"\r\n }\r\n ],\r\n \"created_date\": \"2024-10-16T16:00:00+00:00\",\r\n \"customer_name\": \"Western Construction Ltd\",\r\n \"customer_is_active\": true,\r\n \"customer_info\": {\r\n \"customer_id\": \"550\",\r\n \"bill_to_id\": \"55\",\r\n \"is_bill_to\": false,\r\n \"name\": \"Western Construction Ltd\",\r\n \"street_address\": \"PO BOX 123\",\r\n \"city\": \"Springfield\",\r\n \"state\": \"SK\",\r\n \"zip_code\": \"S0G 5C0\",\r\n \"visibility_ids\": [\r\n \"WEST\",\r\n \"SMITHJ\"\r\n ],\r\n \"internal_user_id\": [\r\n \"SMITHJ\"\r\n ],\r\n \"representative_ids\": [\r\n \"john.smith@company.com\"\r\n ],\r\n \"blacklist_customer_groups\": [\r\n \"_global_blacklist\"\r\n ],\r\n \"customers_search_string\": \"550 Western Construction Ltd Springfield Saskatchewan SK S0G 5C0\",\r\n \"customers_search_string_secondary\": \"PO BOX 123\",\r\n \"proton_score\": 0.0,\r\n \"proton_score_explanation\": \"Last contact days: 5, Last order days: 1, date_score = 0.000452622223240535 Scaler = 0.11574535450000001\",\r\n \"churn_status\": \"active\",\r\n \"churn_probability\": 0.0,\r\n \"churn_explanation\": \"Customer has recently been ordering every 10.0 days on average, and it has been 0.0 days since their last order. This is why they are classified as active.\",\r\n \"product_lines_purchased\": 8,\r\n \"product_lines_purchased_percent\": 15.384615384615385,\r\n \"product_initiatives_count\": 0,\r\n \"product_initiative_keys\": [],\r\n \"opportunities_count\": 1,\r\n \"quote_sales_plays_count\": 3,\r\n \"viewed_online_sales_plays_count\": 0,\r\n \"return_rate\": 0.1506849315068493,\r\n \"first_purchased\": false,\r\n \"is_active\": true,\r\n \"orders_per_week\": 1.4038461538461537,\r\n \"unreturned_orders_count\": 176,\r\n \"returned_orders_count\": 11,\r\n \"total_spending\": 317452.68405246735,\r\n \"average_order_value\": 1493.4508324094015,\r\n \"total_last_year_orders\": 73,\r\n \"YOY\": 30.02556708544346,\r\n \"YOY_Y2D\": 83.23567052629771,\r\n \"YOY_dollars\": 25175.39256978035,\r\n \"YOY_Y2D_dollars\": 46745.735021829605,\r\n \"last_year_spending\": 109021.9107658863,\r\n \"previous_year_spending\": 83846.51819610596,\r\n \"last_year_m2d_spending\": 0,\r\n \"m2d_spending\": 9799.54428100586,\r\n \"y2d_spending\": 102906.43478703499,\r\n \"last_y2d_spending\": 56160.69976520538,\r\n \"gross_margin_last_year\": 24307.592491924763,\r\n \"last_purchase_date\": \"2024-10-15T16:00:00+00:00\",\r\n \"last_contact_date\": \"2024-10-16T16:20:50.122744\",\r\n \"last_ingested_date\": \"2024-10-16T11:11:24.970605\",\r\n \"date_precomputed_first\": \"2024-10-16T11:08:55.139774\",\r\n \"date_precomputed\": \"2024-10-16T11:08:55.250962\",\r\n \"custom_fields\": [\r\n {\r\n \"string_val\": \"WEST\",\r\n \"custom_field_id\": \"custom_branch_id\"\r\n },\r\n {\r\n \"string_val\": \"DEALER\",\r\n \"custom_field_id\": \"custom_customer_type\"\r\n },\r\n {\r\n \"float_val\": 144999.67,\r\n \"custom_field_id\": \"custom_annual_target\"\r\n },\r\n {\r\n \"string_val\": \"WESTA\",\r\n \"custom_field_id\": \"custom_price_class\"\r\n },\r\n {\r\n \"string_val\": \"NET 30 2%\",\r\n \"custom_field_id\": \"custom_terms\"\r\n },\r\n {\r\n \"float_val\": 41707.86,\r\n \"custom_field_id\": \"custom_account_balance\"\r\n },\r\n {\r\n \"float_val\": 26000,\r\n \"custom_field_id\": \"custom_credit_limit\"\r\n },\r\n {\r\n \"float_val\": 1,\r\n \"custom_field_id\": \"custom_days_since_last_order\"\r\n }\r\n ],\r\n \"bill_to\": {\r\n \"customer_id\": \"55\",\r\n \"bill_to_id\": \"55\",\r\n \"is_bill_to\": true,\r\n \"name\": \"Western Construction Group\",\r\n \"street_address\": \"100 Corporate Drive\",\r\n \"city\": \"Regina\",\r\n \"state\": \"SK\",\r\n \"zip_code\": \"S4P 3Y2\",\r\n \"visibility_ids\": [\"WEST\"],\r\n \"internal_user_id\": [\"SMITHJ\"],\r\n \"representative_ids\": [\"john.smith@company.com\"],\r\n \"blacklist_customer_groups\": [\"_global_blacklist\"],\r\n \"customers_search_string\": \"55 Western Construction Group Regina Saskatchewan SK S4P 3Y2\",\r\n \"customers_search_string_secondary\": \"100 Corporate Drive\",\r\n \"proton_score\": 0.0,\r\n \"proton_score_explanation\": \"Last contact days: 2, Last order days: 1, date_score = 0.000452622223240535 Scaler = 0.15\",\r\n \"churn_status\": \"active\",\r\n \"churn_probability\": 0.0,\r\n \"churn_explanation\": \"Customer has never made an order and is thus classified as prospect.\",\r\n \"product_lines_purchased\": 12,\r\n \"product_lines_purchased_percent\": 0.25,\r\n \"product_initiatives_count\": 0,\r\n \"product_initiative_keys\": [],\r\n \"opportunities_count\": 2,\r\n \"quote_sales_plays_count\": 5,\r\n \"viewed_online_sales_plays_count\": 1,\r\n \"return_rate\": 0.0,\r\n \"first_purchased\": false,\r\n \"is_active\": true,\r\n \"orders_per_week\": 4.5,\r\n \"n_shiptos\": 8,\r\n \"unreturned_orders_count\": 425,\r\n \"total_spending\": 450000.00,\r\n \"average_order_value\": 1850.25,\r\n \"total_last_year_orders\": 245,\r\n \"YOY\": 125.5,\r\n \"YOY_Y2D\": 145.2,\r\n \"YOY_dollars\": 55000.00,\r\n \"YOY_Y2D_dollars\": 65000.00,\r\n \"last_year_spending\": 225000.00,\r\n \"previous_year_spending\": 170000.00,\r\n \"last_year_m2d_spending\": 3500.00,\r\n \"m2d_spending\": 4500.00,\r\n \"y2d_spending\": 185000.00,\r\n \"last_y2d_spending\": 120000.00,\r\n \"gross_margin_last_year\": 35000.00,\r\n \"last_purchase_date\": \"2024-10-15T16:00:00+00:00\",\r\n \"last_contact_date\": \"2024-10-14T14:30:00.000000+00:00\",\r\n \"last_ingested_date\": \"2024-10-16T10:00:00.000000+00:00\",\r\n \"date_precomputed_first\": \"2024-10-16T09:00:00.000000+00:00\",\r\n \"date_precomputed\": \"2024-10-16T09:30:00.000000+00:00\"\r\n }\r\n },\r\n \"quote_lines\": [\r\n {\r\n \"interaction_id\": \"S100519712_150_1-quote\",\r\n \"order_id\": \"S100519712.001\",\r\n \"quantity\": 16,\r\n \"net_price\": 2955.949365,\r\n \"margin\": 954.349365,\r\n \"quote_status\": \"open\",\r\n \"product\": {\r\n \"product_id\": \"199738\",\r\n \"name\": \"Double-Bowl Sink Premium Series, Rectangle Shape\",\r\n \"product_super_category\": \"PLB\",\r\n \"product_category\": \"PREMIUM\",\r\n \"manufacturer\": \"ALPHA\",\r\n \"available\": true,\r\n \"available_qty\": 3,\r\n \"date_ingested\": \"2024-10-16 09:00:43.521000+00:00\",\r\n \"blacklist_group\": null,\r\n \"is_deleted\": false,\r\n \"last_ingested_date\": \"2024-10-16T10:15:51.791295\",\r\n \"is_online_product\": true,\r\n \"image_url\": \"https://res.cloudinary.com/company/f_auto,w_200/Images/199738_sink.jpg\",\r\n \"description\": \"Double-Bowl Sink, Rectangle Shape, 16 in Bowl Length, 14 in Bowl Width, 8 in Bowl Depth, 3 Faucet Holes, 2 Bowls, 31-1/4 in x 20-1/2 in Overall, Stainless Steel\",\r\n \"specifications\": \"Bowl Depth: 8 in; Bowl Length: 16 in; Bowl Width: 14 in; Material: Stainless Steel; Number of Bowls: 2\",\r\n \"url\": \"https://company.com/Product/sink-199738\",\r\n \"literature\": [\r\n {\r\n \"name\": \"Specification Sheet\",\r\n \"url\": \"https://res.cloudinary.com/company/Documents/199738_spec_sheet.pdf\"\r\n }\r\n ],\r\n \"ecommerce_product_id\": \"355558192\",\r\n \"other_data\": {\r\n \"custom_product_is_deactivated\": false\r\n },\r\n \"price\": null\r\n },\r\n \"custom_fields\": [\r\n {\r\n \"custom_field_id\": \"custom_quote_branch\",\r\n \"value\": \"WEST\"\r\n },\r\n {\r\n \"custom_field_id\": \"custom_quote_ordered_by\",\r\n \"value\": \"Mark Johnson\"\r\n },\r\n {\r\n \"custom_field_id\": \"custom_quote_writer\",\r\n \"value\": \"SMITHJ\"\r\n },\r\n {\r\n \"custom_field_id\": \"custom_quote_margin_perc\",\r\n \"value\": \"32.29%\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"bc011dd7-ebe1-4150-8ae0-e1dd53f32d3b"},{"name":"Get Quote Header","id":"4fe96cd1-6c66-4a7f-9425-49cdfba7fc1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-User-Id","value":"{{user_id}}","type":"text"},{"key":"X-Company","value":"{{company}}","type":"text"},{"key":"X-Api-Key","value":"{{api_key}}","type":"text"}],"url":"{{domain}}/{{company}}/quote_headers/{quote_id}","description":"This endpoint allows clients to fetch detailed quote header information for specified quote IDs within a company. The response includes quote details, associated products, contacts, customer information, and calculated values such as realized and unrealized values.
\n","urlObject":{"path":["{{company}}","quote_headers","{quote_id}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"4aed3535-8dee-4fe9-9eb1-87b9cf3122a4","name":"Get Quote Header","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-User-Id","value":"{{user_id}}","type":"text"},{"key":"X-Company","value":"{{company}}","type":"text"},{"key":"X-Api-Key","value":"{{api_key}}","type":"text"}],"url":"{{domain}}/{{company}}/quote_headers/4282129"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": {\n \"quote_id\": \"4282129\",\n \"bill_to_id\": \"61300\",\n \"customer_id\": \"61300-1\",\n \"expiration_date\": null,\n \"last_ingested_date\": \"2024-09-13T06:18:54.244812+00:00\",\n \"last_contact_date\": null,\n \"associations\": {},\n \"contact_id\": null,\n \"contact_name\": \"RYAN\",\n \"contact_email\": null,\n \"status_last_modified\": \"2024-09-13T06:33:19.475795+00:00\",\n \"status_erp\": null,\n \"status_rep\": null,\n \"status\": \"open\",\n \"n_days_from_quote_to_order\": 0.0,\n \"total_value\": 11176.9,\n \"remaining_value\": 11176.9,\n \"realized_value\": 0.0,\n \"num_quote_lines\": 11.0,\n \"num_purchased_quote_lines\": 0.0,\n \"source\": \"erp\",\n \"total_value_initial\": 11176.9,\n \"total_value_last_modified\": \"2024-09-13T06:18:54.244812+00:00\",\n \"manufacturer\": \"JAM SYSTEMS\",\n \"quantity_total\": 146,\n \"custom_fields\": [],\n \"created_date\": \"2024-09-12T16:00:00+00:00\",\n \"customer_name\": \"Lloyd Lumber Co\",\n \"customer_is_active\": true\n }\n}"}],"_postman_id":"4fe96cd1-6c66-4a7f-9425-49cdfba7fc1d"},{"name":"Search Quotes","id":"9952f5e0-79b1-4f02-adf1-1a2a1d65156d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","value":"{{user_id}}","type":"text"},{"key":"X-Company","value":"{{company}}","type":"text"},{"key":"X-Api-Key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer_id\":{\"eq\":[\"cust_123\"]},\n \"sort_order\": \"desc\",\n \"count\": 100,\n \"offset\": 0,\n \"all_accounts\": false,\n \"requesting_user_id\": \"protontestaccount@test.com\",\n \"sort_field\": \"created_date\",\n \"total_value\": {\n \"gte\": 50000.00,\n \"lt\": 100000.00\n },\n \"created_date\": {\n \"gte\": \"2023-01-01T00:00:00Z\", // Include quotes created on or after January 1, 2023\n \"lt\": \"2023-12-31T23:59:59Z\" // And before December 31, 2023, 23:59:59\n },\n \"num_quote_lines\": {\n \"gte\": 3.00,\n \"lt\": 20000.00\n },\n \"status\": {\n \"includes\": [\"partial\", \"open\"]\n },\n \"quote_id\": {\n \"contains\": \"80\"\n },\n \"customer_is_active\": {\n \"eq\": true\n },\n \"customer_name\": {\n \"not_contains\": \"AAAAA\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/quote_headers/search","urlObject":{"path":["{{company}}","quote_headers","search"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"1d6f0c2f-2500-47e9-aa24-eb16d5c41d6b","name":"Search Quotes","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customer_id\":{\"eq\":[\"cust_123\"]},\n \"sort_order\": \"desc\",\n \"count\": 100,\n \"offset\": 0,\n \"requesting_user_id\": \"protontestaccount@test.com\",\n \"sort_field\": \"created_date\",\n \"total_value\": {\n \"gte\": 50000.00,\n \"lt\": 100000.00\n },\n \"created_date\": {\n \"gte\": \"2023-01-01T00:00:00Z\", // Include quotes created on or after January 1, 2023\n \"lt\": \"2023-12-31T23:59:59Z\" // And before December 31, 2023, 23:59:59\n },\n \"num_quote_lines\": {\n \"gte\": 3.00,\n \"lt\": 20000.00\n },\n \"status\": {\n \"includes\": [\"partial\", \"open\"]\n },\n \"quote_id\": {\n \"contains\": \"80\"\n },\n \"customer_is_active\": {\n \"eq\": true\n },\n \"customer_name\": {\n \"not_contains\": \"AAAAA\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/quote_headers/search"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": {\n \"quote_headers\": [\n {\n \"quote_id\": \"cust_123\",\n \"created_date\": \"2020-10-22T16:00:00+00:00\",\n \"customer_id\": \"46759-0\",\n \"customer_name\": \"ExampleCustomer\",\n \"customer_is_active\": true,\n \"total_value\": 7.43,\n \"last_contact_date\": null,\n \"status\": \"open\",\n \"num_quote_lines\": 1\n }\n ],\n \"total_count\": 2445\n }\n}"}],"_postman_id":"9952f5e0-79b1-4f02-adf1-1a2a1d65156d"},{"name":"Edit Quote","id":"fcd65ba1-030d-49d7-a2de-c4e3480ba234","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"customer_id\": \"cust-0\",\n \"contact_id\": \"cont-0\",\n \"notes\": \"test_notes\",\n \"quote_lines\": [\n {\n \"interaction_id\": \"123-00-001-quote\",\n \"product_id\": \"METCAL 123\",\n \"quantity\": 3,\n \"net_price\": 196.6,\n \"list_price\": 196.6,\n \"margin\": 25.11,\n \"quote_status\": \"open\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/quotes/{{quote_id}}","urlObject":{"path":["{{company}}","quotes","{{quote_id}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"b7fe8765-4479-4b99-ad22-5f81729eee3d","name":"Search Quotes","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customer_id\":{\"eq\":[\"cust_123\"]},\n \"sort_order\": \"desc\",\n \"count\": 100,\n \"offset\": 0,\n \"requesting_user_id\": \"protontestaccount@test.com\",\n \"sort_field\": \"created_date\",\n \"total_value\": {\n \"gte\": 50000.00,\n \"lt\": 100000.00\n },\n \"created_date\": {\n \"gte\": \"2023-01-01T00:00:00Z\", // Include quotes created on or after January 1, 2023\n \"lt\": \"2023-12-31T23:59:59Z\" // And before December 31, 2023, 23:59:59\n },\n \"num_quote_lines\": {\n \"gte\": 3.00,\n \"lt\": 20000.00\n },\n \"status\": {\n \"includes\": [\"partial\", \"open\"]\n },\n \"quote_id\": {\n \"contains\": \"80\"\n },\n \"customer_is_active\": {\n \"eq\": true\n },\n \"customer_name\": {\n \"not_contains\": \"AAAAA\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/quote_headers/search"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": {\n \"quote_headers\": [\n {\n \"quote_id\": \"cust_123\",\n \"created_date\": \"2020-10-22T16:00:00+00:00\",\n \"customer_id\": \"46759-0\",\n \"customer_name\": \"ExampleCustomer\",\n \"customer_is_active\": true,\n \"total_value\": 7.43,\n \"last_contact_date\": null,\n \"status\": \"open\",\n \"num_quote_lines\": 1\n }\n ],\n \"total_count\": 2445\n }\n}"}],"_postman_id":"fcd65ba1-030d-49d7-a2de-c4e3480ba234"}],"id":"1d8af12e-8509-452a-875f-afc4f3122619","_postman_id":"1d8af12e-8509-452a-875f-afc4f3122619","description":""},{"name":"Leads","item":[{"name":"Search Leads V1","id":"b7dd072b-10c3-4bf6-b6b5-8b58a725bd0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-User-Id","value":"{{user_id}}","type":"text"},{"key":"X-Company","value":"{{company}}","type":"text"},{"key":"X-Api-Key","value":"{{api_key}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{domain}}/{{company}}/v1/leads/search","description":"The Lead Search API v1 endpoint allows you to search for leads within a specific company using a query string and advanced filtering options. This endpoint supports various search operators for flexible and precise lead searches. Leads represent potential customers in your sales pipeline with tracking for stages, sources, and conversion activities.
\nMethod: POST
URL: {{domain}}/{{company}}/v1/leads/search
{\n \"query\": \"string\",\n \"filters\": {\n \"field_name\": {\n \"operator\": value\n }\n },\n \"count\": integer,\n \"offset\": integer\n}\n\nThe following fields can be used in the filters object:
Each filter field can use one or more of the following operators:
\nNote:
\nMultiple operators cannot be used for the same field in a single filter
\nAt least one operator must be defined for each filter field
\nOperators can accept single values or arrays (where applicable)
\n{\n \"query\": \"tech\",\n \"filters\": {\n \"state\": { \"eq\": \"CA\" },\n \"city\": { \"neq\": \"San Jose\" },\n \"street_address\": { \"contains\": \"Main\" },\n \"zip_code\": { \"includes\": [\"55759\", \"70008\", \"11835\"] },\n \"region\": { \"eq\": \"NW\" },\n \"country\": { \"eq\": \"US\" }\n },\n \"count\": 5,\n \"offset\": 0\n}\n\nThis request will:
\nSearch for leads with names containing \"tech\"
\nFilter for leads in California (CA)
\nExclude leads in San Jose
\nInclude only leads with \"Main\" in their street address
\nInclude only leads with zip codes 55759, 70008, or 11835
\nFilter for leads in the Northwest (NW) region
\nFilter for leads in the United States
\n{\n \"status_message\": \"success\",\n \"data\": {\n \"message\": \"\",\n \"items\": [\n {\n \"lead_id\": \"LEAD-001\",\n \"name\": \"Tech Solutions Inc\",\n \"bill_to_id\": \"BT-789012\",\n \"street_address\": \"456 Main Avenue\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip_code\": \"55759\",\n \"email\": \"contact@techsolutions.com\",\n \"fax_number\": \"+1-555-0456\",\n \"office_phone_number\": \"+1-555-0400\",\n \"branch\": \"West Coast\",\n \"region\": \"NW\",\n \"country\": \"US\",\n \"is_active\": true,\n \"lead_stage\": \"qualified\",\n \"lead_source\": \"website\",\n \"lead_created_by\": \"USER-123\",\n \"lead_created_by_name\": \"John Smith\",\n \"lead_created_date\": \"2023-11-15T10:30:00Z\",\n \"lead_update_stage_date\": \"2023-11-20T14:45:00Z\"\n }\n ],\n \"total_count\": 28,\n \"page_size\": 5,\n \"page_number\": 1,\n \"total_pages\": 6\n }\n}\n\nReturned when the request is malformed or contains invalid parameters.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"INVALID_REQUEST\",\n \"message\": \"Invalid filter operator 'contains' for field 'state'. Field 'state' only supports operators: eq, neq\"\n }\n}\n\nReturned when authentication fails or is missing.
\nReturned when the specified company does not exist.
\nReturned when an unexpected error occurs on the server.
\nUse the count and offset parameters to paginate through results:
First page: offset: 0, count: 20
Second page: offset: 20, count: 20
Third page: offset: 40, count: 20
The response includes total_count, page_number, and total_pages to help with pagination navigation.
Use specific queries: Provide at least 3 characters in the query parameter for better performance
Combine filters wisely: Use multiple filters to narrow down results effectively
\nHandle pagination: For large result sets, implement proper pagination to avoid timeouts
\nError handling: Always check the status_message and handle errors appropriately
The search is case-insensitive for the query parameter
Filter operators are case-sensitive for string comparisons
\nEmpty filter values are treated as \"match any\"
\nThe includes operator is particularly useful for matching against multiple possible values
Results are sorted by relevance to the search query by default
\nLead-specific fields (lead_stage, lead_source, etc.) are only populated for records that have lead data
The Contact Search API v1 endpoint allows you to search for contacts within a specific company using a query string and advanced filtering options. This endpoint supports various search operators for flexible and precise contact searches. Contacts represent individual people associated with customers, including their roles, contact information, and relationship details.
\nMethod: POST
URL: {{domain}}/{{company}}/v1/contacts/search
{\n \"query\": \"string\",\n \"filters\": {\n \"field_name\": {\n \"operator\": value\n }\n },\n \"count\": integer,\n \"offset\": integer\n}\n\nThe following fields can be used in the filters object:
Each filter field can use one or more of the following operators:
\nNote:
\nMultiple operators cannot be used for the same field in a single filter
\nAt least one operator must be defined for each filter field
\nOperators can accept single values or arrays (where applicable)
\n{\n \"query\": \"john\",\n \"filters\": {\n \"customer_id\": { \"eq\": \"CUST-12345\" },\n \"contact_type\": { \"includes\": [\"primary\", \"billing\"] },\n \"position\": { \"contains\": \"Manager\" }\n },\n \"count\": 10,\n \"offset\": 0\n}\n\nThis request will:
\nSearch for contacts with names containing \"john\"
\nFilter for contacts associated with customer \"CUST-12345\"
\nInclude only contacts with type \"primary\" or \"billing\"
\nInclude only contacts with \"Manager\" in their position title
\n{\n \"status_message\": \"success\",\n \"data\": {\n \"message\": \"Contacts retrieved successfully\",\n \"items\": [\n {\n \"contact_id\": \"CONTACT-001\",\n \"name\": \"John\",\n \"surname\": \"Smith\",\n \"full_name\": \"John Smith\",\n \"customer_id\": \"CUST-12345\",\n \"customer_name\": \"ABC Manufacturing Corp\",\n \"contact_type\": \"primary\",\n \"position\": \"Operations Manager\",\n \"email\": \"john.smith@abcmanufacturing.com\",\n \"phone_number\": \"+1-555-0123\",\n \"street_address\": \"789 Industrial Blvd\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"country\": \"US\",\n \"zip_code\": \"60601\"\n }\n ],\n \"total_count\": 15,\n \"page_size\": 10,\n \"page_number\": 1,\n \"total_pages\": 2\n }\n}\n\nReturned when the request is malformed or contains invalid parameters.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"INVALID_REQUEST\",\n \"message\": \"Invalid filter operator 'contains' for field 'customer_id'. Field 'customer_id' only supports operators: eq, neq\"\n }\n}\n\nReturned when authentication fails or is missing.
\nReturned when the specified company does not exist.
\nReturned when an unexpected error occurs on the server.
\nUse the count and offset parameters to paginate through results:
First page: offset: 0, count: 20
Second page: offset: 20, count: 20
Third page: offset: 40, count: 20
The response includes total_count, page_number, and total_pages to help with pagination navigation.
Use specific queries: Provide at least 3 characters in the query parameter for better performance
Combine filters wisely: Use multiple filters to narrow down results effectively
\nHandle pagination: For large result sets, implement proper pagination to avoid timeouts
\nError handling: Always check the status_message and handle errors appropriately
Customer association: Use customer_id filter to find all contacts for a specific customer
The search is case-insensitive for the query parameter
Filter operators are case-sensitive for string comparisons
\nEmpty filter values are treated as \"match any\"
\nThe includes operator is particularly useful for matching against multiple contact types
Results are sorted by relevance to the search query by default
\nThe Contact Create API v1 endpoint allows you to create a new contact within a specific company. Contacts represent individual people associated with customers, including their roles, contact information, and relationship details. This endpoint supports comprehensive contact information including multiple email addresses, phone numbers, and custom fields.
\nMethod: POST
URL: {{domain}}/{{company}}/v1/contacts
{\n \"name\": \"string\",\n \"customer_id\": \"string\",\n \"contact_id\": \"string\",\n \"surname\": \"string\",\n \"contact_type\": \"string\",\n \"position\": \"string\",\n \"emails\": [\n {\n \"email\": \"string\"\n }\n ],\n \"phone_numbers\": [\n {\n \"phone_number\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"address\": {\n \"street_address\": \"string\",\n \"street_address_2\": \"string\",\n \"street_address_3\": \"string\",\n \"apartment\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"country\": \"string\",\n \"zip_code\": \"string\"\n },\n \"notes\": \"string\",\n \"custom_fields\": [\n {\n \"field_id\": \"string\",\n \"value\": \"any\"\n }\n ],\n \"external_id\": \"string\",\n \"last_edited_date\": \"string\"\n}\n\n{\n \"name\": \"John\",\n \"surname\": \"Smith\",\n \"customer_id\": \"CUST-12345\",\n \"contact_id\": \"CONTACT-78901\",\n \"contact_type\": \"primary\",\n \"position\": \"Operations Manager\",\n \"emails\": [\n { \"email\": \"john.smith@abcmanufacturing.com\" },\n { \"email\": \"jsmith@personal.com\" }\n ],\n \"phone_numbers\": [\n { \"phone_number\": \"+1-555-0123\", \"type\": \"office\" },\n { \"phone_number\": \"+1-555-0456\", \"type\": \"mobile\" }\n ],\n \"address\": {\n \"street_address\": \"789 Industrial Blvd\",\n \"street_address_2\": \"Suite 100\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"country\": \"US\",\n \"zip_code\": \"60601\"\n },\n \"notes\": \"Primary contact for all operational matters\",\n \"custom_fields\": [\n { \"field_id\": \"department\", \"value\": \"Operations\" },\n { \"field_id\": \"preferred_contact_method\", \"value\": \"email\" }\n ],\n \"external_id\": \"ERP-CONTACT-78901\"\n}\n\nThis request creates a contact with a custom contact_id of \"CONTACT-78901\".
{\n \"name\": \"Jane\",\n \"surname\": \"Doe\",\n \"customer_id\": \"CUST-12345\",\n \"contact_type\": \"billing\",\n \"position\": \"Finance Director\",\n \"emails\": [\n { \"email\": \"jane.doe@abcmanufacturing.com\" }\n ],\n \"phone_numbers\": [\n { \"phone_number\": \"+1-555-0789\", \"type\": \"office\" }\n ]\n}\n\nThis request creates a contact without specifying a contact_id. The system will auto-generate a UUID (e.g., \"550e8400-e29b-41d4-a716-446655440000\") as the contact_id.
{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"contact_id\": \"CONTACT-78901\",\n \"name\": \"John\",\n \"surname\": \"Smith\",\n \"full_name\": \"John Smith\",\n \"customer_id\": \"CUST-12345\",\n \"customer_name\": \"ABC Manufacturing Corp\",\n \"customer_is_active\": true,\n \"contact_type\": \"primary\",\n \"position\": \"Operations Manager\",\n \"emails\": [\n { \"email\": \"john.smith@abcmanufacturing.com\" },\n { \"email\": \"jsmith@personal.com\" }\n ],\n \"phone_numbers\": [\n { \"phone_number\": \"+1-555-0123\", \"type\": \"office\" },\n { \"phone_number\": \"+1-555-0456\", \"type\": \"mobile\" }\n ],\n \"address\": {\n \"street_address\": \"789 Industrial Blvd\",\n \"street_address_2\": \"Suite 100\",\n \"street_address_3\": \"\",\n \"apartment\": \"\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"country\": \"US\",\n \"zip_code\": \"60601\"\n },\n \"custom_fields\": [\n { \"field_id\": \"department\", \"value\": \"Operations\" },\n { \"field_id\": \"preferred_contact_method\", \"value\": \"email\" }\n ],\n \"external_id\": \"ERP-CONTACT-78901\",\n \"representative_ids\": [],\n \"visibility_ids\": null,\n \"representative_ids_synced\": false,\n \"visibility_ids_synced\": false,\n \"bill_to_id\": null,\n \"from_lead\": false,\n \"lead_id\": null,\n \"last_edited_date\": \"2025-01-19T15:30:45Z\",\n \"last_ingested_date\": null,\n \"to_be_deleted\": false,\n \"other_data\": {}\n}\n\nReturned when the request is malformed, contains invalid parameters, or when a contact with the specified contact_id already exists.
{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"INVALID_REQUEST\",\n \"message\": \"Missing required field 'name'\"\n }\n}\n\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"INVALID_REQUEST\",\n \"message\": \"Invalid email format in emails[0]\"\n }\n}\n\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"BAD_REQUEST\",\n \"message\": \"Contact with contact_id 'CONTACT-78901' already exists\"\n }\n}\n\nReturned when authentication fails or is missing.
\nReturned when the specified company or customer_id does not exist.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"Customer with ID 'CUST-12345' not found\"\n }\n}\n\nReturned when an unexpected error occurs on the server.
\nProvide a customer_id: Every contact must be associated with a customer. Ensure the customer exists before creating the contact
\nUse meaningful contact_id: When providing a custom contact_id, use a consistent naming convention that makes sense for your organization. This is especially useful when integrating with external systems
Include complete contact information: Providing emails and phone_numbers enables better communication tracking and searchability
\nLeverage contact_type: Use consistent contact types (e.g., \"primary\", \"billing\", \"technical\", \"executive\") to categorize contacts effectively
\nUse external_id for integrations: When syncing from external systems, always populate external_id to maintain traceability
\nHandle duplicates: Check if a contact already exists before creating to avoid duplicates. Use the search endpoint first if needed
\nThe contact_id field can be explicitly set by the caller to use a custom identifier. This is useful when integrating with external systems that have their own contact IDs. If not provided, the system generates a UUID that will be used as both the internal id and the contact_id
The last_edited_date defaults to the current UTC timestamp if not provided
Fields representative_ids and visibility_ids are typically managed by the system based on customer associations
Empty nested objects (emails, phone_numbers, address) can be omitted from the request
\nThe other_data field can be used to store additional unstructured information not covered by standard fields
The Contact Get API v1 endpoint allows you to retrieve a single contact by its identifier within a specific company. The endpoint returns comprehensive contact information including basic details, contact methods, customer associations, and activity counts (calls, emails, quotes, orders). Contacts represent individual people associated with customers, including their roles, contact information, and relationship details.
\nMethod: GET
URL: {{domain}}/{{company}}/v1/contacts/{{identifier}}
GET /acme-corp/v1/contacts/CONTACT-78901\nGET /acme-corp/v1/contacts/550e8400-e29b-41d4-a716-446655440000\n\ncurl -X GET \"https://api.proton.ai/acme-corp/v1/contacts/550e8400-e29b-41d4-a716-446655440000\" \\\n -H \"Authorization: Bearer <token>\"\n\n{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"contact_id\": \"CONTACT-78901\",\n \"name\": \"John\",\n \"surname\": \"Smith\",\n \"full_name\": \"John Smith\",\n \"customer_id\": \"CUST-12345\",\n \"customer_name\": \"ABC Manufacturing Corp\",\n \"customer_is_active\": true,\n \"contact_type\": \"primary\",\n \"position\": \"Operations Manager\",\n \"emails\": [\n { \"email\": \"john.smith@abcmanufacturing.com\" },\n { \"email\": \"jsmith@personal.com\" }\n ],\n \"phone_numbers\": [\n { \"phone_number\": \"+1-555-0123\", \"type\": \"office\" },\n { \"phone_number\": \"+1-555-0456\", \"type\": \"mobile\" }\n ],\n \"address\": {\n \"street_address\": \"789 Industrial Blvd\",\n \"street_address_2\": \"Suite 100\",\n \"street_address_3\": \"\",\n \"apartment\": \"\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"country\": \"US\",\n \"zip_code\": \"60601\"\n },\n \"notes\": \"Primary contact for all operational matters\",\n \"custom_fields\": [\n { \"field_id\": \"department\", \"value\": \"Operations\" },\n { \"field_id\": \"preferred_contact_method\", \"value\": \"email\" }\n ],\n \"external_id\": \"ERP-CONTACT-78901\",\n \"representative_ids\": [\"user-123\", \"user-456\"],\n \"visibility_ids\": [\"team-sales\"],\n \"representative_ids_synced\": true,\n \"visibility_ids_synced\": true,\n \"bill_to_id\": null,\n \"from_lead\": false,\n \"lead_id\": null,\n \"last_edited_date\": \"2025-01-19T15:30:45Z\",\n \"last_ingested_date\": \"2025-01-15T10:00:00Z\",\n \"to_be_deleted\": false,\n \"other_data\": {},\n \"calls_count\": 12,\n \"emails_count\": 47,\n \"quotes_count\": 3,\n \"orders_count\": 8\n}\n\nReturned when the request is malformed or the identifier is missing.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"BAD_REQUEST\",\n \"message\": \"Either contact_id or id must be provided\"\n }\n}\n\nReturned when authentication fails or is missing.
\nReturned when the specified contact does not exist.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"Contact with id 'CONTACT-99999' does not exist\"\n }\n}\n\nReturned when an unexpected error occurs on the server.
\nUse the appropriate identifier: You can use either the contact_id (external/custom ID) or the internal id (UUID). Both will work with this endpoint
Handle nullable fields: Many fields in the response are nullable. Always check for null values before processing
\nCheck customer association: Use customer_id and customer_is_active to understand the contact's relationship with their associated customer
The identifier path parameter accepts both contact_id (external ID) and id (internal UUID). The system will attempt to find the contact using either identifier
Activity counts (calls_count, emails_count, quotes_count, orders_count) are calculated in real-time and reflect the current state of associated records
The notes field contains internal notes about the contact that may not be suitable for external display (used in html rich-text-editor format)
Representative and visibility IDs control access permissions within the organization
\nThe Contact Edit API v1 endpoint allows you to update an existing contact within a specific company. This endpoint supports partial updates, meaning you only need to provide the fields you want to change. Contacts represent individual people associated with customers, including their roles, contact information, and relationship details.
\nMethod: PUT
URL: {{domain}}/{{company}}/v1/contacts/{{identifier}}
{\n \"contact_id\": \"string\",\n \"name\": \"string\",\n \"surname\": \"string\",\n \"contact_type\": \"string\",\n \"position\": \"string\",\n \"emails\": [\n {\n \"email\": \"string\"\n }\n ],\n \"phone_numbers\": [\n {\n \"phone_number\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"address\": {\n \"street_address\": \"string\",\n \"street_address_2\": \"string\",\n \"street_address_3\": \"string\",\n \"apartment\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"country\": \"string\",\n \"zip_code\": \"string\"\n },\n \"notes\": \"string\",\n \"custom_fields\": [\n {\n \"field_id\": \"string\",\n \"value\": \"any\"\n }\n ],\n \"external_id\": \"string\",\n \"last_edited_date\": \"string\"\n}\n\nAll body parameters are optional, but at least one editable field must be provided.
\nPUT /acme-corp/v1/contacts/CONTACT-78901\n{\n \"name\": \"Jonathan\",\n \"position\": \"Senior Operations Manager\"\n}\n\nThis request updates only the name and position fields, leaving all other fields unchanged.
\nPUT /acme-corp/v1/contacts/CONTACT-78901\n{\n \"emails\": [\n { \"email\": \"jonathan.smith@abcmanufacturing.com\" },\n { \"email\": \"j.smith@personal.com\" }\n ],\n \"phone_numbers\": [\n { \"phone_number\": \"+1-555-9999\", \"type\": \"office\" },\n { \"phone_number\": \"+1-555-8888\", \"type\": \"mobile\" }\n ],\n \"address\": {\n \"street_address\": \"456 Corporate Plaza\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip_code\": \"10001\"\n }\n}\n\nThis request replaces all emails, phone numbers, and the address.
\nPUT /acme-corp/v1/contacts/CONTACT-78901\n{\n \"contact_id\": \"CONTACT-NEW-ID-123\"\n}\n\nThis request changes the external contact_id. The internal id (UUID) remains unchanged.
{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"contact_id\": \"CONTACT-78901\",\n \"name\": \"Jonathan\",\n \"surname\": \"Smith\",\n \"full_name\": \"Jonathan Smith\",\n \"customer_id\": \"CUST-12345\",\n \"customer_name\": \"ABC Manufacturing Corp\",\n \"customer_is_active\": true,\n \"contact_type\": \"primary\",\n \"position\": \"Senior Operations Manager\",\n \"emails\": [\n { \"email\": \"jonathan.smith@abcmanufacturing.com\" },\n { \"email\": \"j.smith@personal.com\" }\n ],\n \"phone_numbers\": [\n { \"phone_number\": \"+1-555-9999\", \"type\": \"office\" },\n { \"phone_number\": \"+1-555-8888\", \"type\": \"mobile\" }\n ],\n \"address\": {\n \"street_address\": \"456 Corporate Plaza\",\n \"street_address_2\": \"\",\n \"street_address_3\": \"\",\n \"apartment\": \"\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"country\": \"US\",\n \"zip_code\": \"10001\"\n },\n \"notes\": \"Primary contact for all operational matters\",\n \"custom_fields\": [\n { \"field_id\": \"department\", \"value\": \"Operations\" }\n ],\n \"external_id\": \"ERP-CONTACT-78901\",\n \"representative_ids\": [\"user-123\", \"user-456\"],\n \"visibility_ids\": [\"team-sales\"],\n \"representative_ids_synced\": true,\n \"visibility_ids_synced\": true,\n \"bill_to_id\": null,\n \"from_lead\": false,\n \"lead_id\": null,\n \"last_edited_date\": \"2025-01-19T16:45:30Z\",\n \"last_ingested_date\": \"2025-01-15T10:00:00Z\",\n \"to_be_deleted\": false,\n \"other_data\": {}\n}\n\nReturned when the request is malformed or no editable fields are provided.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"BAD_REQUEST\",\n \"message\": \"At least one editable field must be provided\"\n }\n}\n\nReturned when authentication fails or is missing.
\nReturned when the specified contact does not exist.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"Contact with id 'CONTACT-99999' does not exist\"\n }\n}\n\nReturned when an unexpected error occurs on the server.
\nPartial updates: Only include fields you want to change. Omitted fields will retain their current values
\nArray fields replace entirely: When updating emails, phone_numbers, address, or custom_fields, the entire array/object is replaced. Include all values you want to keep
Use the appropriate identifier: You can use either contact_id or id in the URL path to identify the contact to update
Changing contact_id: You can update the contact_id field in the request body. The internal id (UUID) will remain unchanged, ensuring referential integrity
Audit trail: All changes are automatically recorded in the audit trail for compliance and tracking purposes
\nVerify before updating: Consider fetching the contact first to ensure you have the latest data before making updates
\nThis endpoint supports partial updates. Only fields included in the request body will be updated; all other fields remain unchanged
\nThe identifier path parameter accepts both contact_id (external ID) and id (internal UUID) for looking up the contact to update
When updating array fields (emails, phone_numbers, custom_fields) or the address object, the new values completely replace the existing values. To add an item, you must include all existing items plus the new one
The last_edited_date is automatically set to the current UTC timestamp if not explicitly provided
Changes are recorded in the audit trail, tracking the old and new values along with the user who made the change
\nFields that cannot be updated via the request body: company, user_id, identifier, id, customer_id, representative_ids, visibility_ids, bill_to_id, from_lead, lead_id, last_ingested_date, to_be_deleted, customer_is_active, customer_name
The Contact Delete API v1 endpoint allows you to permanently delete a contact within a specific company. This endpoint performs a hard delete, physically removing the contact record from the database. The deletion is recorded in the audit trail for compliance and tracking purposes.
\nMethod: DELETE
URL: {{domain}}/{{company}}/v1/contacts/{{identifier}}
No request body is required for this endpoint.
\nDELETE /acme-corp/v1/contacts/CONTACT-78901\nDELETE /acme-corp/v1/contacts/550e8400-e29b-41d4-a716-446655440000\n\ncurl -X DELETE \"https://api.proton.ai/acme-corp/v1/contacts/550e8400-e29b-41d4-a716-446655440000\" \\\n -H \"Authorization: Bearer <token>\"\n\n{\n \"contact_id\": \"CONTACT-78901\",\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\"\n}\n\nReturned when the request is malformed or the identifier is missing.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"BAD_REQUEST\",\n \"message\": \"Either contact_id, id, or identifier must be provided\"\n }\n}\n\nReturned when authentication fails or is missing.
\nReturned when the specified contact does not exist.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"Contact with id 'CONTACT-99999' does not exist\"\n }\n}\n\nReturned when an unexpected error occurs on the server.
\nConfirm before deleting: This operation permanently removes the contact. Consider implementing a confirmation step in your application before calling this endpoint
\nUse the appropriate identifier: You can use either the contact_id (external ID) or id (internal UUID) to identify the contact to delete
Check for dependencies: Before deleting a contact, consider checking if there are related records (calls, emails, quotes, orders) that may be orphaned
\nStore the response: The response contains both identifiers of the deleted contact, which can be useful for logging or undo functionality in your application
\nThis endpoint performs a hard delete
\nThe identifier path parameter accepts both contact_id (external ID) and id (internal UUID) for identifying the contact to delete
Once deleted, the contact cannot be retrieved via the Get Contact API. Any subsequent requests for the deleted contact will return a 404 Not Found error
\nDeleting a contact does not automatically delete related records such as calls, emails, quotes, or orders. These records may become orphaned
\nThe same contact_id can be reused after deletion when creating a new contact
Manage contact records within your Proton account. Contacts represent individual people associated with customers — including their roles, communication details, and relationship information. Each contact is linked to a customer and can have multiple emails, phone numbers, and custom fields.
\nUse these endpoints to create, retrieve, update, delete, and search contacts programmatically.
\n","_postman_id":"49b6e2fd-557b-4663-b304-54d9c85c5da3"},{"name":"Call Notes","item":[{"name":"Search Call Notes V1","id":"d94e1762-95ad-4d12-af75-9a86343fb4b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","value":"{{user_id}}","type":"text"},{"key":"X-Company","value":"{{company}}","type":"text"},{"key":"X-Api-Key","value":"{{api_key}}","type":"text"}],"url":"{{domain}}/{{company}}/v1/call_notes/search","description":"The Call Notes Search API v1 endpoint allows you to search for call notes within a specific company using a query string and advanced filtering options. This endpoint supports various search operators for flexible and precise call note searches. Call notes represent recorded interactions between sales representatives and customers, including notes, pitched products, and associated metadata.
\nMethod: POST
URL: {{domain}}/{{company}}/v1/call-notes/search
{\n \"query\": \"string\",\n \"filters\": {\n \"field_name\": {\n \"operator\": value\n }\n },\n \"count\": integer,\n \"offset\": integer,\n \"sort_field\": \"string\",\n \"sort_order\": \"asc\" | \"desc\"\n}\n\nThe following fields can be used in the filters object:
Each filter field can use one or more of the following operators:
\nNote:
\nMultiple operators cannot be used for the same field in a single filter
\nAt least one operator must be defined for each filter field
\nOperators can accept single values or arrays (where applicable)
\n{\n \"query\": \"follow-up\",\n \"filters\": {\n \"customer_id\": { \"eq\": \"CUST-12345\" },\n \"call_type\": { \"includes\": [\"phone\", \"email\"] },\n \"date\": { \"gte\": \"2024-01-01T00:00:00Z\" },\n \"customer_is_active\": { \"eq\": true }\n },\n \"count\": 10,\n \"offset\": 0,\n \"sort_field\": \"date\",\n \"sort_order\": \"desc\"\n}\n\nThis request will:
\nSearch for call notes containing \"follow-up\" in the notes
\nFilter for call notes associated with customer \"CUST-12345\"
\nInclude only \"phone\" or \"email\" call types
\nInclude only call notes from January 1, 2024 onwards
\nInclude only call notes for active customers
\nSort results by date in descending order (newest first)
\n {\n \"status_message\": \"SUCCESS\",\n \"data\": {\n \"message\": \"\",\n \"items\": [\n {\n \"call_id\": \"8678b142-1111-45ec-84ad-1148b416e7fe\",\n \"interaction_id\": \"1ef31a20-5555-436c-9c96-5b9ddfefdb99\",\n \"user_id\": \"testuser@test.com\",\n \"customer_id\": \"123\",\n \"customer_name\": \"Example name\",\n \"bill_to_id\": \"123-1\",\n \"call_type\": \"phone\",\n \"date\": \"2025-07-26T01:40:41+00:00\",\n \"notes\": \"test notes\",\n \"tagged_users\": [],\n \"custom_fields\": [],\n \"attachments\": [],\n \"associations\": [\n {\n \"type\": \"task\",\n \"task_id\": \"1784bb05-3333-4def-8cc3-ecdeed9988f7\"\n }\n ],\n \"additional_info\": {\n \"contact_id\": \"12345\",\n \"contact_name\": \"Jon Doe\"\n },\n \"customer_is_active\": true,\n \"pitched_items\": [\n {\n \"interaction_id\": \"8f8ef5b3-2222-425e-b467-ea85bc7e73f0\",\n \"product_id\": \"15\",\n \"product_name\": \"Product Name Exaple\",\n \"product_category\": \"Lighting\",\n \"pitch_order\": 0,\n \"pitch_key\": \"product_id\",\n \"pitch_value\": \"15\",\n \"subject\": \"initiative_replacement\"\n },\n {\n \"interaction_id\": \"dbeedff2-1111-4f5e-8044-6542801007a6\",\n \"product_id\": \"179\",\n \"product_name\": \"Zip Ties Cable Wire Black\",\n \"product_category\": \"Wires, Cords & Cables\",\n \"pitch_order\": 1,\n \"pitch_key\": \"product_id\",\n \"pitch_value\": \"179\",\n \"subject\": \"campaign\"\n }\n ]\n }\n ],\n \"total_count\": 5,\n \"page_size\": 20,\n \"page_number\": 1,\n \"total_pages\": 1\n }\n}\n\nReturned when the request is malformed or contains invalid parameters.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"INVALID_REQUEST\",\n \"message\": \"Invalid filter operator 'contains' for field 'customer_is_active'. Field 'customer_is_active' only supports operators: eq, neq, exists\"\n }\n}\n\nReturned when authentication fails or is missing.
\nReturned when the specified company does not exist.
\nReturned when an unexpected error occurs on the server.
\nUse the count and offset parameters to paginate through results:
First page: offset: 0, count: 20
Second page: offset: 20, count: 20
Third page: offset: 40, count: 20
The response includes total_count, page_number, and total_pages to help with pagination navigation.
Note: Maximum page size is 100 items to avoid overwhelming the system.
\nUse the sort_field and sort_order parameters to sort results:
sort_field: The field name to sort by (e.g., \"date\", \"customer_name\")
sort_order: Either \"asc\" (ascending) or \"desc\" (descending), defaults to \"asc\"
Use specific filters: Combine multiple filters to narrow down results effectively
\nDate range queries: Use gte and lte operators together to query date ranges
Handle pagination: For large result sets, implement proper pagination using count and offset
Error handling: Always check the status_message and handle errors appropriately
Customer association: Use customer_id filter to find all call notes for a specific customer
User filtering: Use user_id filter to find call notes created by a specific sales representative
The search query matches against call note content
\nFilter operators are case-sensitive for string comparisons
\nEmpty filter values are treated as \"match any\"
\nThe includes operator is useful for matching against multiple call types
Pitched items are automatically included for each call note returned
\nDate filters expect ISO 8601 format (e.g., \"2024-01-01T00:00:00Z\")
\nThe Call Note Create API v1 endpoint allows you to create a new call note for one or more customers within a specific company. The endpoint accepts call details, optional pitched items (products presented during the call), custom fields, associations (linked entities such as opportunities, quotes, orders, and campaigns), and file attachments. When multiple customers are specified, a separate call note is created for each customer, linked together via a shared call ID. Call notes represent logged interactions between sales representatives and customers, capturing the details and outcomes of calls.
\nMethod: POST\nURL: {{domain}}/{{company}}/v1/call_notes
POST /acme-corp/v1/call_notes\ncurl -X POST \"https://api.proton.ai/acme-corp/v1/call_notes\" \\\n -H \"X-Company: acme-corp\" \\\n -H \"X-User-ID: user-456\" \\\n -H \"X-Api-Key: <api_key>\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"user_id\": \"user-456\",\n \"customer_ids\": [\"CUST-12345\"],\n \"call_type\": \"phone\",\n \"notes\": \"Discussed Q1 order forecasts and new product line availability.\",\n \"date\": \"2025-01-20T14:30:00Z\",\n \"tagged_users\": [\n { \"user_id\": \"user-789\", \"name\": \"Jane Doe\" }\n ],\n \"custom_fields\": [\n { \"custom_field_id\": \"call_outcome\", \"value\": \"follow_up_needed\" }\n ],\n \"additional_info\": {\n \"contact_id\": \"CONTACT-001\"\n },\n \"associations\": [\n { \"type\": \"opportunity\", \"opportunity_id\": \"OPP-5678\" },\n { \"type\": \"quote\", \"quote_id\": \"QUO-9012\" }\n ],\n \"pitched_items\": [\n {\n \"pitch_key\": \"product_id\",\n \"pitch_value\": \"PROD-001\",\n \"product_id\": \"PROD-001\",\n \"subject\": \"Industrial Widget A\",\n \"pitch_order\": 1\n }\n ]\n}'\ncurl -X POST \"https://api.proton.ai/acme-corp/v1/call_notes\" \\\n -H \"X-Company: acme-corp\" \\\n -H \"X-User-ID: user-456\" \\\n -H \"X-Api-Key: <api_key>\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"user_id\": \"user-456\",\n \"customer_ids\": [\"CUST-12345\", \"CUST-67890\"],\n \"call_type\": \"phone\",\n \"notes\": \"Group call to discuss upcoming bulk order.\"\n}'\n{\n \"call_notes\": [\n {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"call_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"interaction_id\": \"d4e5f6a7-b8c9-0123-def0-456789abcdef\",\n \"user_id\": \"user-456\",\n \"customer_id\": \"CUST-12345\",\n \"date\": \"2025-01-20T14:30:00Z\",\n \"activity_id\": \"phone_a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"call_type\": \"phone\",\n \"notes\": \"Discussed Q1 order forecasts and new product line availability.\",\n \"tagged_users\": [\n { \"user_id\": \"user-789\", \"name\": \"Jane Doe\" }\n ],\n \"additional_info\": {\n \"contact_id\": \"CONTACT-001\"\n },\n \"associations\": [\n { \"type\": \"opportunity\", \"opportunity_id\": \"OPP-5678\" },\n { \"type\": \"quote\", \"quote_id\": \"QUO-9012\" }\n ],\n \"custom_fields\": [\n { \"custom_field_id\": \"call_outcome\", \"value\": \"follow_up_needed\" }\n ],\n \"customer_name\": \"ABC Manufacturing Corp\",\n \"bill_to_id\": \"BILL-001\",\n \"customer_is_active\": true,\n \"visibility_ids\": [\"team-sales\"],\n \"representative_ids\": [\"user-456\"],\n \"mode\": \"phone\",\n \"action\": \"general_call_notes\"\n }\n ]\n}\nThe response contains a call_notes array with one entry per customer specified in the request. Each call note object contains the following fields (null fields are omitted from the response):
Note: The pitched_items field is excluded from the response, even though pitched items are created and stored. Use the Get Call Note endpoint to retrieve the full call note with pitched items.
Returned when the request is malformed, required fields are missing, or referenced entities do not exist.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"BAD_REQUEST\",\n \"message\": \"The following customer_ids do not exist: ['CUST-99999']\"\n }\n}\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"BAD_REQUEST\",\n \"message\": \"The following product_ids do not exist: ['PROD-99999']\"\n }\n}\nReturned when authentication fails or is missing.
\nReturned when an unexpected error occurs on the server.
\ncustomer_ids and product IDs referenced in pitched_items must exist in the system. The endpoint returns 400 if any are invalidpitched_items with pitch_key set to \"product_id\" and both pitch_value and product_id set to the product identifiercustomer_ids. The system creates separate but linked call notes (via shared_call_id) for each customerassociations array to link the call note to related entities like opportunities, quotes, orders, and campaigns. Quote associations are validated to ensure the quote's customer matches the call note's customercustomer_ids. If three customers are specified, three call note records are created, each with its own unique id, call_id, and interaction_idshared_call_id fieldcustomer_ids are automatically deduplicateduser_id field is automatically lowercaseddate field defaults to the current time if not providednotes field supports HTML rich-text contentactivity_id is auto-generated in the format phone_{call_id}call_note.created webhook eventThe Call Note Edit API v1 endpoint allows you to update an existing call note by its identifier within a specific company. The endpoint accepts updated call details including notes text, call type, tagged users, custom fields, associations, and file attachments. Only the original creator of the call note can edit it. The response returns the updated call note with all current field values.
\nMethod: PUT\nURL: {{domain}}/{{company}}/v1/call_notes/{{identifier}}
PUT /acme-corp/v1/call_notes/550e8400-e29b-41d4-a716-446655440000\ncurl -X PUT \"https://api.proton.ai/acme-corp/v1/call_notes/550e8400-e29b-41d4-a716-446655440000\" \\\n -H \"X-Company: acme-corp\" \\\n -H \"X-User-ID: user-456\" \\\n -H \"X-Api-Key: <api_key>\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"notes\": \"Updated: Discussed Q1 order forecasts. Customer confirmed bulk order for widget series.\",\n \"call_type\": \"phone\",\n \"tagged_users\": [\n { \"user_id\": \"user-789\", \"name\": \"Jane Doe\" },\n { \"user_id\": \"user-101\", \"name\": \"Bob Johnson\" }\n ],\n \"custom_fields\": [\n { \"custom_field_id\": \"call_outcome\", \"value\": \"order_confirmed\" }\n ],\n \"associations\": [\n { \"type\": \"opportunity\", \"opportunity_id\": \"OPP-5678\" },\n { \"type\": \"quote\", \"quote_id\": \"QUO-9012\" },\n { \"type\": \"order\", \"order_id\": \"ORD-3456\" }\n ]\n}'\n{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"call_id\": \"CALL-12345\",\n \"interaction_id\": \"INT-78901\",\n \"user_id\": \"user-456\",\n \"customer_id\": \"CUST-12345\",\n \"call_type\": \"phone\",\n \"date\": \"2025-01-20T14:30:00Z\",\n \"notes\": \"Updated: Discussed Q1 order forecasts. Customer confirmed bulk order for widget series.\",\n \"action\": \"general_call_notes\",\n \"mode\": \"phone\",\n \"tagged_users\": [\n { \"user_id\": \"user-789\", \"name\": \"Jane Doe\" },\n { \"user_id\": \"user-101\", \"name\": \"Bob Johnson\" }\n ],\n \"custom_fields\": [\n { \"custom_field_id\": \"call_outcome\", \"value\": \"order_confirmed\" }\n ],\n \"associations\": [\n { \"type\": \"opportunity\", \"opportunity_id\": \"OPP-5678\" },\n { \"type\": \"quote\", \"quote_id\": \"QUO-9012\" },\n { \"type\": \"order\", \"order_id\": \"ORD-3456\" }\n ],\n \"additional_info\": {\n \"contact_id\": \"CONTACT-001\"\n },\n \"last_edited_date\": \"2025-01-21T09:15:30.123456\"\n}\nReturned when the request is malformed or the identifier is missing.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"BAD_REQUEST\",\n \"message\": \"Either call_id or identifier must be provided\"\n }\n}\nReturned when authentication fails, is missing, or the requesting user is not the call note owner.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"UNAUTHORIZED\",\n \"message\": \"Requesting user user-999 does not have permission to edit this interaction created by user-456\"\n }\n}\nReturned when the specified call note does not exist.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"No call note found with identifier 'INT-99999'\"\n }\n}\nReturned when an unexpected error occurs on the server (e.g., file attachment upload failure).
\nX-User-ID header) can edit it. Attempting to edit another user's call note returns 401null (or omitted) preserve existing values. Fields set to an empty array [] clear existing values. Fields set to a new value replace existing values entirelyassociations, provide the complete desired list. Any file associations present in the old list but absent in the new list will be deleted. New file attachments are automatically appended to the associations listidentifier path parameter is not the same as call_id. The call_id is a grouping key shared by the call note and all its pitched items. The identifier resolves to the individual record's interaction_id or id, and the system then uses the resolved record's call_id internallyX-User-ID header must match the user_id stored on the call notelast_edited_date field is automatically set to the current UTC time on every editdate field (original call date) cannot be changed via this endpointnotes field defaults to an empty string if omitted from the request body — to preserve existing notes, include the current valuecall_type field defaults to \"phone\" if omitted — to preserve the existing call type, include the current valueassociations list are soft-deleted asynchronously. Deletion failures are logged but do not cause the request to failcall_note.updated webhook event is published after a successful edit, including the full call note details and any pitched itemsThe Call Note Delete API v1 endpoint allows you to delete an existing call note by its identifier within a specific company. Deleting a call note permanently removes the call note record and all associated pitched items from the database. Associated files are soft-deleted, comments are soft-deleted, and interaction snapshots are created as an audit trail before deletion. Related entities (customers, contacts, opportunities, quotes, orders) have their last contact dates recalculated. Only the original creator of the call note can delete it.
\nMethod: DELETE
URL: {{domain}}/{{company}}/v1/call_notes/{{identifier}}
DELETE /acme-corp/v1/call_notes/550e8400-e29b-41d4-a716-446655440000\n\ncurl -X DELETE \"https://api.proton.ai/acme-corp/v1/call_notes/550e8400-e29b-41d4-a716-446655440000\" \\\n -H \"X-Company: acme-corp\" \\\n -H \"X-User-ID: user-456\" \\\n -H \"X-Api-Key: <api_key>\"\n\n{\n \"message\": \"Successfully deleted call note\"\n}\n\nReturned when the call note has pitched products and is older than 24 hours.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"BAD_REQUEST\",\n \"message\": \"Call notes with pitched products cannot be deleted after 24 hours\"\n }\n}\n\nReturned when the call note has pitched products that are attributed.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"BAD_REQUEST\",\n \"message\": \"Call note with pitched products cannot be deleted when it's attributed\"\n }\n}\n\nReturned when authentication fails, is missing, or the requesting user is not the call note owner.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"UNAUTHORIZED\",\n \"message\": \"Requesting user user-999 does not have permission to delete this interaction created by user-456\"\n }\n}\n\nReturned when the specified call note does not exist.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"No call note found with identifier 'INT-99999'\"\n }\n}\n\nReturned when an unexpected error occurs on the server.
\nCall notes with pitched products have additional restrictions:
\nOwnership required: Only the original creator of the call note (matched via X-User-ID header) can delete it. Attempting to delete another user's call note returns 401
Check for pitched products: Call notes with pitched products have a 24-hour deletion window. Plan deletions accordingly
\nAttribution blocks deletion: If any pitched product has been attributed (linked to revenue), the call note cannot be deleted at all
\nDeletion is permanent: The call note and pitched items are hard-deleted from the database. Interaction snapshots provide an audit trail, but the records cannot be restored via the API
\nThe identifier path parameter is not the same as call_id. The call_id is a grouping key shared by the call note and all its pitched items. The identifier resolves to the individual record's interaction_id or id, and the system then uses the resolved record's call_id internally
Only the call note owner can delete — the X-User-ID header must match the user_id stored on the call note
Deleting a call note also deletes all associated pitched items in the same database operation
\nInteraction snapshots are created for both the call note and all pitched items before deletion, preserving an audit trail
\nAfter deletion, last_contact_date is recalculated on all related entities: the associated customer (handling both bill-to and ship-to relationships), contacts (from both associations and additional_info.contact_id), opportunities, quotes, and orders
Quote and order associations referencing the deleted call note are cleaned up on those entities
\nA call_note.deleted webhook event is published after successful deletion, including the full call note details and pitched items in the payload
Redis cache entries for pitched products are cleared when the call note had pitched items
\nThe Call Note Get API v1 endpoint allows you to retrieve a single call note by its identifier within a specific company. The endpoint returns comprehensive call note information including core call details, tagged users, custom fields, associations (linked entities such as opportunities, quotes, and files), customer information, and pitched items (products presented during the call). Call notes represent logged interactions between sales representatives and customers, capturing the details and outcomes of calls.
\nMethod: GET\nURL: {{domain}}/{{company}}/v1/call_notes/{{identifier}}
GET /acme-corp/v1/call_notes/INT-78901\nGET /acme-corp/v1/call_notes/550e8400-e29b-41d4-a716-446655440000\ncurl -X GET \"https://api.proton.ai/acme-corp/v1/call_notes/550e8400-e29b-41d4-a716-446655440000\" \\\n -H \"X-Company: acme-corp\" \\\n -H \"X-User-ID: user-456\" \\\n -H \"X-Api-Key: <api_key>\"\n{\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"call_id\": \"CALL-12345\",\n \"interaction_id\": \"INT-78901\",\n \"user_id\": \"user-456\",\n \"customer_id\": \"CUST-12345\",\n \"call_type\": \"phone\",\n \"date\": \"2025-01-20T14:30:00Z\",\n \"notes\": \"Discussed Q1 order forecasts and new product line availability. Customer interested in bulk pricing for widget series.\",\n \"action\": \"general_call_notes\",\n \"mode\": \"phone\",\n \"shared_call_id\": null,\n \"tagged_users\": [\n { \"id\": \"user-789\", \"name\": \"Jane Doe\" }\n ],\n \"custom_fields\": [\n { \"field_id\": \"call_outcome\", \"value\": \"follow_up_needed\" },\n { \"field_id\": \"next_steps\", \"value\": \"Send updated pricing sheet\" }\n ],\n \"attachments\": [\n { \"file_name\": \"pricing_sheet_q1.pdf\", \"url\": \"https://storage.example.com/files/pricing_sheet_q1.pdf\" }\n ],\n \"associations\": [\n { \"type\": \"opportunity\", \"id\": \"OPP-5678\", \"name\": \"Q1 Bulk Order\" },\n { \"type\": \"quote\", \"id\": \"QUO-9012\", \"name\": \"Widget Series Quote\" }\n ],\n \"additional_info\": {},\n \"customer_info\": {\n \"customer_id\": \"CUST-12345\",\n \"customer_name\": \"ABC Manufacturing Corp\",\n \"is_active\": true\n },\n \"pitched_items\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"interaction_id\": \"INT-78902\",\n \"call_id\": \"CALL-12345\",\n \"customer_id\": \"CUST-12345\",\n \"product_id\": \"PROD-001\",\n \"pitch_key\": \"product_id\",\n \"pitch_value\": \"PROD-001\",\n \"pitch_order\": 1,\n \"subject\": \"Industrial Widget A\",\n \"action\": \"checked\",\n \"product_blob\": {\n \"product_id\": \"PROD-001\",\n \"product_name\": \"Industrial Widget A\",\n \"product_category\": \"Widgets\",\n \"product_super_category\": \"Industrial Components\",\n \"manufacturer\": \"WidgetCo\"\n }\n }\n ]\n}\nReturned when the request is malformed or the identifier is missing.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"BAD_REQUEST\",\n \"message\": \"Either call_id or identifier must be provided\"\n }\n}\nReturned when authentication fails or is missing.
\nReturned when the specified call note does not exist.
\n{\n \"status_message\": \"error\",\n \"error\": {\n \"code\": \"NOT_FOUND\",\n \"message\": \"No call note found with identifier 'INT-99999'\"\n }\n}\nReturned when an unexpected error occurs on the server (e.g., associated customer record not found).
\nidentifier path parameter accepts either the interaction_id (primary key) or the internal id (UUID). It does not accept call_id directly — see Notes for detailspitched_items array contains products presented during the call. Use the product_blob field for full product details when availableassociations array links the call note to related entities like opportunities, quotes, and files — use these to navigate the full context of the callidentifier path parameter is not the same as call_id. The call_id is a grouping key shared by the call note and all its pitched items. The identifier resolves to the individual record's interaction_id or id, and the system then uses the resolved record's call_id internally to fetch the complete call note with all pitched itemsnotes field contains call note text that may be in HTML rich-text-editor format and may not be suitable for direct plain-text displayaction field distinguishes between the main call note record (\"general_call_notes\") and pitched item records (\"checked\"). The API response separates these into the top-level fields and the pitched_items array respectivelyproduct_blob are populated only when pitch_key is \"product_id\" and the referenced product exists in the systemCustomer/Account ID
\n","type":"text/plain"},"key":"customer_id","value":"231539-01"},{"description":{"content":"The count of Product Initiatives to retrieve
\n","type":"text/plain"},"key":"count","value":"10"},{"description":{"content":"pagination
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"9153f573-39c7-461b-9400-0eb0d0a1b72d","name":"Product Initiatves example","originalRequest":{"method":"GET","header":[{"key":"X-User-Id","value":"{{user_id}}","type":"text"},{"key":"X-Company","value":"{{company}}","type":"text"},{"key":"X-Api-Key","value":"{{api_key}}","type":"text"}],"url":{"raw":"{{domain}}/{{company}}/product_initiatives/all?customer_id=163853-0,84553-0","host":["{{domain}}"],"path":["{{company}}","product_initiatives","all"],"query":[{"key":"customer_id","value":"163853-0,84553-0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"24789"},{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"5"}],"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": [\n {\n \"id\": \"f0a178d0-7e01-41bd-bb7f-16b0247bfb51\",\n \"type\": \"replacement\",\n \"last_updated\": \"2022-09-12T04:10:18.534871\",\n \"is_new\": true,\n \"date_created\": \"2022-09-12T04:10:18.534876\",\n \"customer_id\": \"163853-0\",\n \"category\": \"order\",\n \"content\": {\n \"trigger_product\": {\n \"product_id\": \"079340-26392\",\n \"name\": \"Loctite 573 Gasket Sealant Green Paste 250 ml Tube - 26392, IDH: 232000\",\n \"price\": 89.05,\n \"product_category\": \"Sealants & Fillers\",\n \"date_ingested\": \"2022-09-10 08:27:58.073000+00:00\",\n \"available_qty\": 4,\n \"group_id\": \"079340-26392\",\n \"available\": true,\n \"literature\": [],\n \"last_ingested_date\": \"2022-09-10T10:10:33.375417\",\n \"manufacturer\": \"HENKEL\",\n \"specifications\": \"Brand Loctite Loctite Number 573 Chemical Base Acrylic Maximum Operating Temperature +300 °F Cure Time 48 hr Material Compatibility Metal Product Form Paste Package Type Tube Package Size 250 ml Shear Strength 217 psi Tensile Strength 725 psi Minimum Operating Temperature -65 °F Color Green Viscosity Measurement 19000 cPs Storage Condition Store Between 46°F to 82°F Store in a Dry Area Package Quantity 250 ml per inner, 10 per case IDH Number 232000\",\n \"product_super_category\": \"Adhesives & Sealants\",\n \"last_purchase\": {\n \"date\": \"2022-07-22T23:59:00-04:56\",\n \"quantity\": 2,\n \"product_id\": \"079340-26392\",\n \"net_price\": 163.38774,\n \"order_id\": \"79839121-00\"\n },\n \"description\": \"Loctite 573 green gasket sealant is compatible with metal materials with a 48 hr cure time. Delivers great performance with a shear strength of 217 psi and tensile strength of 725 psi. Minimum to maximum operating temperatures are -65 F to +300 F. Comes in a 250 ml Tube. This gasket sealant is packaged 250 ml per inner, 10 per case. The IDH number for this item is 232000.\",\n \"cost\": 60.56\n },\n \"recommended_products\": [\n {\n \"product_id\": \"MC-8694K41\",\n \"name\": \"NEOPRENE .125''THK C/C 4; '' X 50FT NEOPRENE/EPDM/\",\n \"price\": 38.21,\n \"product_category\": \"\",\n \"date_ingested\": \"2022-09-10 08:27:58.073000+00:00\",\n \"image_url\": \"\",\n \"available_qty\": 0,\n \"group_id\": \"MC-8694K41\",\n \"available\": false,\n \"literature\": [],\n \"last_ingested_date\": \"2022-09-10T10:10:33.351385\",\n \"manufacturer\": \"Unknown\",\n \"specifications\": \"\",\n \"product_super_category\": \"\",\n \"last_purchase\": null,\n \"description\": \"\",\n \"cost\": 26.75\n },\n {\n \"product_id\": \"RTV88 RED 001\",\n \"name\": \"Momentive RTV88 Two-Part Potting & Encapsulating Compound Red Paste 1 pt Kit - RTV88 RED 001\",\n \"price\": 90.12,\n \"product_category\": \"Sealants & Fillers\",\n \"date_ingested\": \"2022-09-10 08:27:58.073000+00:00\",\n \"available_qty\": 27,\n \"group_id\": \"RTV88 RED 001\",\n \"available\": true,\n \"literature\": [],\n \"last_ingested_date\": \"2022-09-10T10:21:06.964752\",\n \"manufacturer\": \"MOMENTIVE\",\n \"specifications\": \"Brand Momentive Series RTV88 Chemical Base Silicone Multi-Part Adhesive Two-Part Thermal Conductivity 0.31 W/mK Dielectric Strength 430 V/mil Cure Time 24 hr Working Life 45 min Color Red Product Form Paste Package Type Kit Package Size 1 pt\",\n \"product_super_category\": \"Adhesives & Sealants\",\n \"last_purchase\": {\n \"date\": \"2017-12-29T00:00:00-05:00\",\n \"quantity\": 2,\n \"product_id\": \"RTV88 RED 001\",\n \"net_price\": 211.36,\n \"order_id\": \"77075474-00\"\n },\n \"description\": \"Momentive red two-part RTV88 potting & encapsulating compound with a 24 hr cure time. Provides a 45 min working time. Comes in a 1 pt Kit.\",\n \"cost\": 58.58\n },\n {\n \"product_id\": \"686226-80011\",\n \"name\": \"Permatex Form-A-Gasket 2C Gasket Sealant Black Paste 11 oz Tube - 80011\",\n \"price\": 18.42,\n \"product_category\": \"Sealants & Fillers\",\n \"date_ingested\": \"2022-09-10 08:27:58.073000+00:00\",\n \"available_qty\": 11,\n \"group_id\": \"686226-80011\",\n \"available\": true,\n \"literature\": [\n {\n }\n ],\n \"last_ingested_date\": \"2022-09-10T10:22:58.329209\",\n \"manufacturer\": \"ITW PERFORMANCE POLYMERS\",\n \"specifications\": \"Brand Permatex Trade Name Form-A-Gasket Series 2C Chemical Base Resin Maximum Operating Temperature +400 °F Cure Time 24 hr Material Compatibility Metal Product Form Paste Package Type Tube Package Size 11 oz Minimum Operating Temperature -65 °F Color Black Storage Condition Store Between 46°F to 82°F Package Quantity 11 oz per inner, 12 per case\",\n \"product_super_category\": \"Adhesives & Sealants\",\n \"last_purchase\": {\n \"date\": \"2021-06-23T23:59:00-04:00\",\n \"quantity\": 40,\n \"product_id\": \"686226-80011\",\n \"net_price\": 375.2,\n \"order_id\": \"79174325-01\"\n },\n \"description\": \"Permatex Form-A-Gasket black 2C gasket sealant is compatible with metal materials with a 24 hr cure time. Minimum to maximum operating temperatures are -65 F to +400 F. Comes in a 11 oz Tube. This gasket sealant is packaged 11 oz per inner, 12 per case.\",\n \"cost\": 11.98\n }\n ],\n \"title\": \"Test title\",\n \"description\": \"Test description\"\n }\n },\n {\n \"id\": \"9cfb0a6e-88e4-401b-82c0-010af9d10918\",\n \"type\": \"replacement\",\n \"last_updated\": \"2022-09-12T04:10:18.535204\",\n \"is_new\": true,\n \"date_created\": \"2022-09-12T04:10:18.535206\",\n \"customer_id\": \"84553-0\",\n \"category\": \"order\",\n \"content\": {\n \"trigger_product\": {\n \"product_id\": \"079340-26392\",\n \"name\": \"Loctite 573 Gasket Sealant Green Paste 250 ml Tube - 26392, IDH: 232000\",\n \"price\": 89.05,\n \"product_category\": \"Sealants & Fillers\",\n \"date_ingested\": \"2022-09-10 08:27:58.073000+00:00\",\n \"available_qty\": 4,\n \"group_id\": \"079340-26392\",\n \"available\": true,\n \"literature\": [],\n \"last_ingested_date\": \"2022-09-10T10:10:33.375417\",\n \"manufacturer\": \"HENKEL\",\n \"specifications\": \"Brand Loctite Loctite Number 573 Chemical Base Acrylic Maximum Operating Temperature +300 °F Cure Time 48 hr Material Compatibility Metal Product Form Paste Package Type Tube Package Size 250 ml Shear Strength 217 psi Tensile Strength 725 psi Minimum Operating Temperature -65 °F Color Green Viscosity Measurement 19000 cPs Storage Condition Store Between 46°F to 82°F Store in a Dry Area Package Quantity 250 ml per inner, 10 per case IDH Number 232000\",\n \"product_super_category\": \"Adhesives & Sealants\",\n \"last_purchase\": {\n \"date\": \"2022-07-22T23:59:00-04:56\",\n \"quantity\": 2,\n \"product_id\": \"079340-26392\",\n \"net_price\": 163.38774,\n \"order_id\": \"79839121-00\"\n },\n \"description\": \"Loctite 573 green gasket sealant is compatible with metal materials with a 48 hr cure time. Delivers great performance with a shear strength of 217 psi and tensile strength of 725 psi. Minimum to maximum operating temperatures are -65 F to +300 F. Comes in a 250 ml Tube. This gasket sealant is packaged 250 ml per inner, 10 per case. The IDH number for this item is 232000.\",\n \"cost\": 60.56\n },\n \"recommended_products\": [\n {\n \"product_id\": \"MC-8694K41\",\n \"name\": \"NEOPRENE .125''THK C/C 4; '' X 50FT NEOPRENE/EPDM/\",\n \"price\": 38.21,\n \"product_category\": \"\",\n \"date_ingested\": \"2022-09-10 08:27:58.073000+00:00\",\n \"image_url\": \"\",\n \"available_qty\": 0,\n \"group_id\": \"MC-8694K41\",\n \"available\": false,\n \"literature\": [],\n \"last_ingested_date\": \"2022-09-10T10:10:33.351385\",\n \"manufacturer\": \"Unknown\",\n \"specifications\": \"\",\n \"product_super_category\": \"\",\n \"last_purchase\": null,\n \"description\": \"\",\n \"cost\": 26.75\n },\n {\n \"product_id\": \"RTV88 RED 001\",\n \"name\": \"Momentive RTV88 Two-Part Potting & Encapsulating Compound Red Paste 1 pt Kit - RTV88 RED 001\",\n \"price\": 90.12,\n \"product_category\": \"Sealants & Fillers\",\n \"date_ingested\": \"2022-09-10 08:27:58.073000+00:00\",\n \"available_qty\": 27,\n \"group_id\": \"RTV88 RED 001\",\n \"available\": true,\n \"literature\": [],\n \"last_ingested_date\": \"2022-09-10T10:21:06.964752\",\n \"manufacturer\": \"MOMENTIVE\",\n \"specifications\": \"Brand Momentive Series RTV88 Chemical Base Silicone Multi-Part Adhesive Two-Part Thermal Conductivity 0.31 W/mK Dielectric Strength 430 V/mil Cure Time 24 hr Working Life 45 min Color Red Product Form Paste Package Type Kit Package Size 1 pt\",\n \"product_super_category\": \"Adhesives & Sealants\",\n \"last_purchase\": {\n \"date\": \"2017-12-29T00:00:00-05:00\",\n \"quantity\": 2,\n \"product_id\": \"RTV88 RED 001\",\n \"net_price\": 211.36,\n \"order_id\": \"77075474-00\"\n },\n \"description\": \"Momentive red two-part RTV88 potting & encapsulating compound with a 24 hr cure time. Provides a 45 min working time. Comes in a 1 pt Kit.\",\n \"cost\": 58.58\n },\n {\n \"product_id\": \"686226-80011\",\n \"name\": \"Permatex Form-A-Gasket 2C Gasket Sealant Black Paste 11 oz Tube - 80011\",\n \"price\": 18.42,\n \"product_category\": \"Sealants & Fillers\",\n \"date_ingested\": \"2022-09-10 08:27:58.073000+00:00\",\n \"available_qty\": 11,\n \"group_id\": \"686226-80011\",\n \"available\": true,\n \"literature\": [\n {\n }\n ],\n \"last_ingested_date\": \"2022-09-10T10:22:58.329209\",\n \"manufacturer\": \"ITW PERFORMANCE POLYMERS\",\n \"specifications\": \"Brand Permatex Trade Name Form-A-Gasket Series 2C Chemical Base Resin Maximum Operating Temperature +400 °F Cure Time 24 hr Material Compatibility Metal Product Form Paste Package Type Tube Package Size 11 oz Minimum Operating Temperature -65 °F Color Black Storage Condition Store Between 46°F to 82°F Package Quantity 11 oz per inner, 12 per case\",\n \"product_super_category\": \"Adhesives & Sealants\",\n \"last_purchase\": {\n \"date\": \"2021-06-23T23:59:00-04:00\",\n \"quantity\": 40,\n \"product_id\": \"686226-80011\",\n \"net_price\": 375.2,\n \"order_id\": \"79174325-01\"\n },\n \"description\": \"Permatex Form-A-Gasket black 2C gasket sealant is compatible with metal materials with a 24 hr cure time. Minimum to maximum operating temperatures are -65 F to +400 F. Comes in a 11 oz Tube. This gasket sealant is packaged 11 oz per inner, 12 per case.\",\n \"cost\": 11.98\n }\n ],\n \"title\": \"Test title\",\n \"description\": \"Test description\"\n }\n }\n ],\n \"customer_id\": [\n \"163853-0,84553-0\"\n ]\n}"}],"_postman_id":"9c3c4570-f23e-47ae-9518-8ff4e49ec641"},{"name":"Create Task","id":"e4a8cf08-c1c2-4c64-b31e-ca92e4997200","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"body":{"mode":"formdata","formdata":[{"key":"user_id","value":"joe.doe@acme.com","type":"text"},{"key":"title","value":"Follow up on new product","type":"text"},{"key":"due_date","value":"2023-10-15T22:00:00.000Z","type":"text"},{"key":"note","value":"Customer visit planned next month","type":"text"},{"key":"associations","value":"[{\"type\":\"customer\",\"customer_id\":\"105301\"},{\"type\":\"product\",\"product_id\":\"DEF-456\"},{\"type\":\"product\",\"product_id\":\"ABC-123\"},{\"type\":\"opportunity\",\"opportunity_id\":\"GaveiKsASvcmnatYoaj468\"}]","type":"text"}]},"url":"{{domain}}/{{company}}/create/task","urlObject":{"path":["{{company}}","create","task"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"eeac76f8-3a9a-492c-b7d3-80d8cfa6f5fa","name":"Create Task","originalRequest":{"method":"POST","header":[{"key":"X-User-Id","type":"text","value":"{{user_id}}"},{"key":"X-Company","type":"text","value":"{{company}}"},{"key":"X-Api-Key","type":"text","value":"{{api_key}}"}],"body":{"mode":"formdata","formdata":[{"key":"user_id","value":"joe.doe@acme.com","type":"text"},{"key":"title","value":"Follow up on new product","type":"text"},{"key":"due_date","value":"2023-10-15T22:00:00.000Z","type":"text"},{"key":"note","value":"Customer visit planned next month","type":"text"},{"key":"associations","value":"[{\"type\":\"customer\",\"customer_id\":\"105301\"},{\"type\":\"product\",\"product_id\":\"DEF-456\"},{\"type\":\"product\",\"product_id\":\"ABC-123\"},{\"type\":\"opportunity\",\"opportunity_id\":\"GaveiKsASvcmnatYoaj468\"}]","type":"text"}]},"url":"{{domain}}/{{company}}/create/task"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": {\n \"task_id\": \"473987eb-6c09-436b-b9d7-714082760eab\"\n }\n}"}],"_postman_id":"e4a8cf08-c1c2-4c64-b31e-ca92e4997200"},{"name":"Update Task","id":"39dac172-475b-47a3-b9fa-98d496093bd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-User-Id","value":"{{user_id}}","type":"text"},{"key":"X-Company","value":"{{company}}","type":"text"},{"key":"X-Api-Key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"task_id\": \"8e05aaaa-b955-4958-850d-f1b12c2496c9\",\n \"completed\": true,\n \"user_id\": [\n \"joe.doe@acme.com\"\n ],\n \"requesting_user_id\": \"protontestaccount@acme.com\",\n \"title\": \"Test task\",\n \"due_date\": \"2023-10-15T22:00:00.000Z\",\n \"note\": \"test\",\n \"associations\": [\n {\n \"type\": \"customer\",\n \"customer_id\": \"00531-01\"\n },\n {\n \"type\": \"product\",\n \"product_id\": \"ABC-123\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/edit/task","urlObject":{"path":["{{company}}","edit","task"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"e60c6481-7511-4370-8958-71cbfaedf196","name":"Update Task","originalRequest":{"method":"POST","header":[{"key":"X-User-Id","value":"{{user_id}}","type":"text"},{"key":"X-Company","value":"{{company}}","type":"text"},{"key":"X-Api-Key","value":"{{api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"task_id\": \"8e05aabd-b955-4958-850d-f6b12c2496c9\",\n \"completed\": true,\n \"user_id\": [\n \"joe.doe@acme.com\"\n ],\n \"requesting_user_id\": \"protontestaccount@aquiferdist.com\",\n \"title\": \"Test task\",\n \"due_date\": \"2023-10-15T22:00:00.000Z\",\n \"note\": \"test\",\n \"associations\": [\n {\n \"type\": \"customer\",\n \"customer_id\": \"20531-11\"\n },\n {\n \"type\": \"product\",\n \"product_id\": \"ABC-123\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/{{company}}/edit/task"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status_message\": \"SUCCESS\",\n \"data\": {\n \"task_id\": \"08951cea-6185-4d58-aeb5-aa5de75ffff0\"\n }\n}"}],"_postman_id":"39dac172-475b-47a3-b9fa-98d496093bd6"}],"event":[{"listen":"prerequest","script":{"id":"60efd321-62bd-43ec-b5cf-36e363ff53bb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eefefe39-83bf-4276-9c63-2a8841875bde","type":"text/javascript","exec":[""]}}]}