{"info":{"_postman_id":"a39095dc-c1b4-46ab-a3cb-3c8001848c1c","name":"CRM API documentation | API key use","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"<html><head></head><body></body></html>","owner":"28133629","collectionId":"a39095dc-c1b4-46ab-a3cb-3c8001848c1c","publishedId":"2s9Yyv9ey6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-02-01T18:52:58.000Z"},"item":[{"name":"Get leads list","event":[{"listen":"test","script":{"id":"6484c6dc-8664-47c5-a616-191bc85ad753","exec":[""],"type":"text/javascript"}}],"id":"5557f460-501c-4e01-b8ac-346bb4b1e1b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"your own api key","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{domain.com}/customer/integrations-lead?from=2023-12-05T14:48:00.000Z&to=2024-02-05T14:48:00.000Z&isDeposit=true","description":"<p>Params:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>param</strong></th>\n<th><strong>format</strong></th>\n<th><strong>example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>from</td>\n<td>ISO date forma or UTC date format</td>\n<td>2011-10-05T14:48:00.000Z</td>\n</tr>\n<tr>\n<td>to</td>\n<td>ISO date forma or UTC date format</td>\n<td>2023-11-05T14:48:00.000Z</td>\n</tr>\n<tr>\n<td>isDeposit</td>\n<td>true / false / 0 / 1</td>\n<td>true</td>\n</tr>\n</tbody>\n</table>\n</div><p>Your own api key(<em><strong>x-api-key</strong></em>) you can get from your manager</p>\n","urlObject":{"protocol":"https","path":["customer","integrations-lead"],"host":["{domain","com}"],"query":[{"key":"from","value":"2023-12-05T14:48:00.000Z"},{"key":"to","value":"2024-02-05T14:48:00.000Z"},{"key":"isDeposit","value":"true"}],"variable":[]}},"response":[{"id":"dccbb2cf-b5f7-4bfa-8508-61eac1b15528","name":"Get leads list","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"54562bc1-ca24-5a1d-8cd1-29b88cb4b8cf","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{domain.com}/customer/integrations-lead?from=2023-12-05T14:48:00.000Z&to=2024-02-05T14:48:00.000Z&isDeposit=true","protocol":"https","host":["{domain","com}"],"path":["customer","integrations-lead"],"query":[{"key":"from","value":"2023-12-05T14:48:00.000Z"},{"key":"to","value":"2024-02-05T14:48:00.000Z"},{"key":"isDeposit","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 01 Feb 2024 18:47:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"ff-qfP1xF323CorwjvV1LqH1XYt+jA\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=S1QlvmjLTEpgPK2UaUxXV0duHdWFbtgVGcsgHrqCfFbyp4SHwL7wmiB%2FXEELYFpIGVVU4m%2BQutY1ynOqbhx1PNjXc6o151BTy5X98Im8IFHl6Kx1zsMu6nTKcGaUKEPRDeA%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"84ec5cb118a76a57-EWR"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"callStatus\": \"deposit\",\n        \"createdAt\": \"2024-02-01T15:04:13.216Z\",\n        \"uuid\": \"0a257dfc-f08c-57f1-b0a4-023d19b13c0b\",\n        \"isDeposit\": true\n    },\n    {\n        \"callStatus\": \"deposit\",\n        \"createdAt\": \"2024-02-01T15:05:57.951Z\",\n        \"uuid\": \"4b4f05e1-bdc5-5e18-b95c-bfcd3efc6996\",\n        \"isDeposit\": true\n    }\n]"}],"_postman_id":"5557f460-501c-4e01-b8ac-346bb4b1e1b0"},{"name":"Send lead","id":"53b81e09-5261-419c-ad0e-9b44f4232b3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"your own api key","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"phone\": \"+1234567890\",\n  \"email\": \"email@mail.com\",\n  \"boxId\": 1,\n  \"name\": \"John\",\n  \"lastName\": \"Smith\",\n  \"userAgent\": \"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\",\n  \"ip\": \"111.11.11.11\",\n  \"country\": \"US\",\n  \"lang\": \"EN\",\n  \"offerId\": \"1\",\n  \"sub1\": \"string1\",\n  \"sub2\": \"string2\",\n  \"sub3\": \"string3\",\n  \"sub4\": \"string4\",\n  \"sub5\": \"string5\",\n  \"sub6\": \"string6\",\n  \"sub7\": \"string7\",\n  \"sub8\": \"string7\",\n  \"platform\": \"platform url\",\n  \"utmCampaign\": \"utm_campaign\",\n  \"utmSource\": \"utm_source\",\n  \"utmContent\": \"utm_content\",\n  \"utmMedium\": \"utm_medium\"\n}"},"url":"https://{domain.com}/customer/lead","description":"<p>Fields:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>field</strong></th>\n<th><strong>required</strong></th>\n<th><strong>type</strong></th>\n<th><strong>standart</strong></th>\n<th><strong>example</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><strong>phone</strong></td>\n<td>+</td>\n<td>number</td>\n<td>Е.164 (without parentheses)</td>\n<td>+380123456789</td>\n</tr>\n<tr>\n<td><strong>email</strong></td>\n<td>+</td>\n<td>string</td>\n<td>RFC</td>\n<td><a href=\"https://\">testemail@gmail.com</a></td>\n</tr>\n<tr>\n<td><strong>boxId</strong></td>\n<td>+</td>\n<td>number</td>\n<td></td>\n<td>10</td>\n</tr>\n<tr>\n<td><strong>name</strong></td>\n<td>+</td>\n<td>string</td>\n<td></td>\n<td>Harry</td>\n</tr>\n<tr>\n<td><strong>lastName</strong></td>\n<td>+</td>\n<td>string</td>\n<td></td>\n<td>Potter</td>\n</tr>\n<tr>\n<td><strong>userAgent</strong></td>\n<td>+</td>\n<td>string</td>\n<td>RFC9110</td>\n<td>User-Agent: Mozilla/5.0 () ()</td>\n</tr>\n<tr>\n<td><strong>ip</strong></td>\n<td>+</td>\n<td>string</td>\n<td>IPv4</td>\n<td>192.158.1.38</td>\n</tr>\n<tr>\n<td><strong>country</strong></td>\n<td>+</td>\n<td>string</td>\n<td>alpha-2</td>\n<td>GB</td>\n</tr>\n<tr>\n<td><strong>lang</strong></td>\n<td>+</td>\n<td>string</td>\n<td>alpha-2</td>\n<td>EN</td>\n</tr>\n<tr>\n<td><strong>offerId</strong></td>\n<td></td>\n<td>number</td>\n<td></td>\n<td>10</td>\n</tr>\n<tr>\n<td><strong>sub1</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>sub2</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>sub3</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>sub4</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>sub5</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>sub6</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>sub7</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>sub8</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>platform</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>utmCampaign</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>utmSource</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>utmContent</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><strong>utmMedium</strong></td>\n<td></td>\n<td>string</td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>Your own api key(<em><strong>x-api-key</strong></em>) you can get from your manager</p>\n","urlObject":{"protocol":"https","path":["customer","lead"],"host":["{domain","com}"],"query":[],"variable":[]}},"response":[{"id":"1a3b974e-4820-48c6-90e4-bf1bf13decd9","name":"Send lead","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"54562bc1-ca24-5a1d-8cd1-29b88cb4b8cf","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"phone\": \"+1234567890\",\n  \"email\": \"email@mail.com\",\n  \"boxId\": 1,\n  \"name\": \"John\",\n  \"lastName\": \"Smith\",\n  \"userAgent\": \"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\",\n  \"ip\": \"111.11.11.11\",\n  \"country\": \"US\",\n  \"lang\": \"EN\",\n  \"offerId\": \"1\",\n  \"sub1\": \"string1\",\n  \"sub2\": \"string2\",\n  \"sub3\": \"string3\",\n  \"sub4\": \"string4\",\n  \"sub5\": \"string5\",\n  \"sub6\": \"string6\",\n  \"sub7\": \"string7\",\n  \"sub8\": \"string7\",\n  \"platform\": \"platform url\",\n  \"utmCampaign\": \"utm_campaign\",\n  \"utmSource\": \"utm_source\",\n  \"utmContent\": \"utm_content\",\n  \"utmMedium\": \"utm_medium\"\n}"},"url":"https://{domain.com}/customer/lead"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Apr 2024 13:18:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"149"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=oM77PY+VB7yvDBDdUMrXvERHxIaox7LXO+GI3YL2gU+Tnv+x3Coj8dmb8apVPSxY8wgBSUDfuT5RCjbLQHX364WCXyVT+erody0PKJQains+fS/TaT1mF4YFv4Tk; Expires=Mon, 08 Apr 2024 13:18:01 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=oM77PY+VB7yvDBDdUMrXvERHxIaox7LXO+GI3YL2gU+Tnv+x3Coj8dmb8apVPSxY8wgBSUDfuT5RCjbLQHX364WCXyVT+erody0PKJQains+fS/TaT1mF4YFv4Tk; Expires=Mon, 08 Apr 2024 13:18:01 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"nginx/1.24.0"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"95-GwjVyyKrmescfovb7PPstXTHS0k\""}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"success\",\n    \"uuid\": \"8a51f78e-8894-5f89-b5b3-7e61def21322\",\n    \"autologinLink\": \"https://{domain.com}/prod/autologin?hash=316938307&step=2\"\n}"}],"_postman_id":"53b81e09-5261-419c-ad0e-9b44f4232b3a"}]}