This document serves as a documentation for the leads API. Below are all of the available methods to interact with the API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8183569","collectionId":"ecf4b582-d915-468b-9fe0-42a8e90b28d0","publishedId":"TzXumKVw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-05-24T10:35:54.000Z"},"item":[{"name":"Emails","id":"ab20be92-5bba-4ab8-a1fe-17b3bef4f3f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"","type":"text","description":"E-mail addres. This value must contain a valid e-mail address.
\n"},{"key":"first_name","value":"John","type":"text","description":"Lead's first name. This value may only contain letters. Value must be at least 2 characters.
\n"},{"key":"last_name","value":"Doe","type":"text","description":"Lead's last name. This value may only contain letters. Value must be at least 2 characters
\n"},{"key":"funnel","value":"cfdtrader","description":"This value will depend on the funnel you're using. This can be a selfmade value, but can be requested as well. Using existing slugs will increase conversion rates. Single word, only lowercase alphanumeric characters allowed.
\n","type":"text"},{"key":"hitid","value":"abc12345","description":"Click ID, if you don't provide a click id, one will be generated for you.
\n","type":"text"}]},"url":"https://digitapi.net/emails","description":"Endpoint for email verification, subscription to mailing lists. This endpoint could be used for verification purposes. This endpoint does not registrate your lead as a full lead.
\n","urlObject":{"protocol":"https","path":["emails"],"host":["digitapi","net"],"query":[],"variable":[]}},"response":[{"id":"31b13b55-fa75-470f-9a6a-f8c9393c759c","name":"Successful post","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"john.doe@mailinator.com","type":"text","description":"Lead's email. This value must contain an existing e-mail. This value will be verified against external verification tools. test@test.com will not work for example."},{"key":"first_name","value":"John","type":"text","description":"Lead's first name. This value may only contain letters. Value must be at least 2 characters."},{"key":"last_name","value":"Doe","type":"text","description":"Lead's last name. This value may only contain letters. Value must be at least 2 characters"},{"key":"funnel","value":"bitcointrader","description":"This value will depend on the funnel you're using. This can be a selfmade value, but can be requested as well. Using existing slugs will increase conversion rates. Single word, only lowercase alphanumeric characters allowed.","type":"text"},{"key":"hitid","value":"abc12345","description":"Click ID, if you don't provide a click id, one will be generated for you.","type":"text"}]},"url":"https://digitapi.net/emails"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"email\": \"john.doe@mailinator.com\",\n \"funnel\": \"cfdtrader\",\n \"hitid\": \"abc12345\",\n \"country\": \"NL\",\n \"updated_at\": \"2019-08-14 10:48:52\",\n \"created_at\": \"2019-08-14 10:48:50\",\n \"id\": 2273683,\n \"is_optin\": true,\n \"valid\": true\n}"},{"id":"933e78f4-4637-42bf-81dc-fe7a6f171c9b","name":"Post failure - errors","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"","type":"text","description":"Lead's email. This value must contain an existing e-mail. This value will be verified against external verification tools. test@test.com will not work for example."},{"key":"first_name","value":"John","type":"text","description":"Lead's first name. This value may only contain letters. Value must be at least 2 characters."},{"key":"last_name","value":"Doe","type":"text","description":"Lead's last name. This value may only contain letters. Value must be at least 2 characters"},{"key":"funnel","value":"bitcointrader","description":"This value will depend on the funnel you're using. This can be a selfmade value, but can be requested as well. Using existing slugs will increase conversion rates. Single word, only lowercase alphanumeric characters allowed.","type":"text"},{"key":"hitid","value":"abc12345","description":"Click ID, if you don't provide a click id, one will be generated for you.","type":"text"}]},"url":"https://digitapi.net/emails"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n \"The email field is required.\"\n ]\n}"}],"_postman_id":"ab20be92-5bba-4ab8-a1fe-17b3bef4f3f4"},{"name":"Leads","id":"b4ef366a-d707-47a9-882e-5016bdd64516","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"first_name","value":"John","type":"text","description":"Lead's first name. This value may only contain letters. Value must be at least 2 characters.
\n"},{"key":"last_name","value":"Doe","type":"text","description":"Lead's last name. This value may only contain letters. Value must be at least 2 characters
\n"},{"key":"password","value":"Qbwriu48","type":"text","description":"Valid password.
\nPassword rules:
\nEmail address of the lead
\n"},{"key":"funnel","value":"bitcoinrevolution","type":"text","description":"This value will depend on the funnel you will be using.
\n"},{"key":"affid","value":"3","type":"text","description":"Your affiliate ID.
\n"},{"key":"area_code","value":"+44","type":"text","description":"Valid country calling code. https://en.wikipedia.org/wiki/List_of_country_calling_codes
\n"},{"key":"phone","value":"504286660","type":"text","description":"Valid phonenumber. We verify phonenumbers against an external service, so dummy numbers can give errors.
\n"},{"key":"_ip","value":"1.1.1.1","type":"text","description":"Optional parameter. Valid IP address. This value overrides the client's IP address. (Client IP address: the one that makes the request, usually this value gets set for server to server communciation)
\n"},{"key":"hitid","value":"tracker_id","type":"text","description":"Click ID, if you don't provide a click id, one will be generated for you.
\n"}]},"url":"https://digitapi.net/leads","description":"This endpoint provides a way to to post leads. Please review all parameters and their verification rules.
\n","urlObject":{"protocol":"https","path":["leads"],"host":["digitapi","net"],"query":[],"variable":[]}},"response":[{"id":"f34039b7-d030-4974-9770-ab3b8d207f50","name":"Successful lead submit","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"first_name","value":"Jane","type":"text","description":"Lead's first name. This value may only contain letters. Value must be at least 2 characters."},{"key":"last_name","value":"Doe","type":"text","description":"Lead's last name. This value may only contain letters. Value must be at least 2 characters"},{"key":"email","value":"john.doe@mailinator.com","type":"text","description":"Lead's email. This value must contain an existing e-mail. This value will be verified against external verification tools. test@test.com will not work for example."},{"key":"password","value":"Testing1","type":"text","description":"Valid password. \n\nPassword rules: \n- Minimum characters: 6\n- Maximum characters: 12\n- 1 uppercase character\n- 1 lowercase character\n- 1 numeric character"},{"key":"funnel","value":"cfdtrader","type":"text","description":"This value will depend on the funnel you will be using. Contact ROI for the funnel slug you have to use."},{"key":"affid","value":"3","type":"text","description":"Your affiliate ID. (Provided by ROI)"},{"key":"area_code","value":"+44","type":"text","description":"Valid country calling code. https://en.wikipedia.org/wiki/List_of_country_calling_codes"},{"key":"phone","value":"7400123456","type":"text","description":"Valid phonenumber. We verify phonenumbers against an external service, so dummy numbers can give errors. "},{"key":"_ip","value":"86.129.129.34","type":"text","description":"Optional parameter. Valid IP address. This value overrides the client's IP address. (Client IP address: the one that makes the request, usually this value gets set for server to server communciation)"},{"key":"hitid","value":"abc1234","description":"Click ID, if you don't provide a click id, one will be generated for you.","type":"text"}]},"url":"https://digitapi.net/leads"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"lead\": {\n \"id\": 1366043,\n \"email\": \"john.doe@mailinator.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"eyJpdiI6InFDeDBRakk2bWpVKzlnSHhDVFl5Wmc9PSIsInZhbHVlIjoiaVVka0pzVWFBTmd2RkF3aGRPMnBDeUZZaW5GYm5GXC9semRDaEN6T0NXb1E9IiwibWFjIjoiZDRmYzEzNDEzYzcwMDJmNDI5NzBmNzllNDg3ZGUzZmFjZTkzNDEwOWE5ZmJhZTVkODdkMWM5ZmZhYjBhZDE3NyJ9\",\n \"funnel\": \"cfdtrader\",\n \"hitid\": \"abc1234\",\n \"user_id\": \"68191\",\n \"broker_id\": 987,\n \"converted\": 0,\n \"created_at\": \"2019-08-14 15:52:51\",\n \"updated_at\": \"2019-08-14 15:52:52\",\n \"reminder\": 0,\n \"affid\": 3,\n \"autologin\": 0,\n \"is_mobile\": 0,\n \"custom_field_1\": \"https://autologinexample.com/api/autologin?param=deposit\",\n \"custom_field_2\": null,\n \"sale_status\": null,\n \"first_time_deposit\": null,\n \"is_login_valid\": 1,\n \"paid\": 0,\n \"ip\": \"86.129.129.34\"\n },\n \"extras\": {\n \"user_id\": \"a4weE453\",\n \"redirect\": {\n \"url\": \"https://autologinexample.com/api/autologin?param=deposit\",\n \"method\": \"get\",\n \"secureConnection\": true,\n \"params\": []\n },\n \"broker_name\": \"Broker Name\",\n \"broker_id\": 987\n },\n \"broker\": {\n \"id\": 987,\n \"name\": \"Broker name\",\n \"slug\": \"brokername\",\n \"image1\": \"broker_name.png\",\n \"image2\": null\n }\n}"},{"id":"609d9930-ff36-402c-afe4-d3fd08a519c7","name":"validation error example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"first_name","value":"","type":"text","description":"Lead's first name. This value may only contain letters. Value must be at least 2 characters."},{"key":"last_name","value":"Doe","type":"text","description":"Lead's last name. This value may only contain letters. Value must be at least 2 characters"},{"key":"email","value":"john.doe@mailinator.com","type":"text","description":"Lead's email. This value must contain an existing e-mail. This value will be verified against external verification tools. test@test.com will not work for example."},{"key":"password","value":"Testing1","type":"text","description":"Valid password. \n\nPassword rules: \n- Minimum characters: 6\n- Maximum characters: 12\n- 1 uppercase character\n- 1 lowercase character\n- 1 numeric character"},{"key":"funnel","value":"bitcointrader","type":"text","description":"This value will depend on the funnel you're using. This can be a selfmade value, but can be requested as well. Using existing slugs will increase conversion rates. Single word, only lowercase alphanumeric characters allowed."},{"key":"affid","value":"3","type":"text","description":"Your affiliate ID. (Provided by ROI)"},{"key":"area_code","value":"+44","type":"text","description":"Valid country calling code. https://en.wikipedia.org/wiki/List_of_country_calling_codes"},{"key":"phone","value":"2075927332","type":"text","description":"Valid phonenumber. We verify phonenumbers against an external service, so dummy numbers can give errors. "},{"key":"_ip","value":"86.129.129.34","type":"text","description":"Optional parameter. Valid IP address. This value overrides the client's IP address. (Client IP address: the one that makes the request, usually this value gets set for server to server communciation)"},{"key":"hitid","value":"abc1234","description":"Click ID, if you don't provide a click id, one will be generated for you.","type":"text"}]},"url":"https://digitapi.net/leads"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n \"The first name field is required.\"\n ]\n}"},{"id":"cc43896d-91a9-42d2-b91d-7e78dc477fdf","name":"Leads success response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"first_name","value":"John","type":"text","description":"Lead's first name. This value may only contain letters. Value must be at least 2 characters."},{"key":"last_name","value":"Doe","type":"text","description":"Lead's last name. This value may only contain letters. Value must be at least 2 characters"},{"key":"email","value":"john.doe@mailinator.com","type":"text","description":"Lead's email. This value must contain an existing e-mail. This value will be verified against external verification tools. test@test.com will not work for example."},{"key":"password","value":"Testing1","type":"text","description":"Valid password. \n\nPassword rules: \n- Minimum characters: 6\n- Maximum characters: 12\n- 1 uppercase character\n- 1 lowercase character\n- 1 numeric character"},{"key":"funnel","value":"cryptocfdtrader","type":"text","description":"This value will depend on the funnel you will be using. Contact ROI for the funnel slug you have to use."},{"key":"affid","value":"3","type":"text","description":"Your affiliate ID. (Provided by ROI)"},{"key":"area_code","value":"+44","type":"text","description":"Valid country calling code. https://en.wikipedia.org/wiki/List_of_country_calling_codes"},{"key":"phone","value":"7400123456","type":"text","description":"Valid phonenumber. We verify phonenumbers against an external service, so dummy numbers can give errors. "},{"key":"_ip","value":"86.129.129.34","type":"text","description":"Optional parameter. Valid IP address. This value overrides the client's IP address. (Client IP address: the one that makes the request, usually this value gets set for server to server communciation)"},{"key":"hitid","value":"abc1234","description":"Click ID, if you don't provide a click id, one will be generated for you.","type":"text"}]},"url":"https://digitapi.net/leads"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.0"},{"key":"X-Trace","value":"2B2CE4389ED58D9B37CC2138370A391A4190FFC5AAFA7893AE245A27AD01"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Wed, 11 Sep 2019 09:55:41 GMT"},{"key":"Set-Cookie","value":"laravel_session=ea07bbf930c0013b6acd6df46c0ef82d1495f0f3; path=/; HttpOnly"},{"key":"X-Frame-Options","value":"ALLOWALL"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"53446"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"{\n \"lead\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@mailinator.com\",\n \"funnel\": \"cfdtrader\",\n \"affid\": \"3\",\n \"phone\": \"eyJpdiI6InB3WHpUVzZ3M1JROFNsQXpYRHhLenc9PSIsInZhbHVlIjoiaHd5RFFPdWlRXC94ajUxRVwvV1E5dlk3NTJEbTF6Y1NudzZFUEg4YzhVcm84PSIsIm1hYyI6IjhjMTIwMDgzM2RiNGFkZjVkOTJlMDI0NDdjYTE3YmFiYzlkZWQ2OWExZGE4NWQyYjFmZmM3NmVmYWQ3ZGY5ZTkifQ==\",\n \"hitid\": \"abc1234\",\n \"custom_field_2\": null,\n \"is_mobile\": false,\n \"ip\": \"86.129.129.34\",\n \"updated_at\": \"2019-09-11 11:55:00\",\n \"created_at\": \"2019-09-11 11:54:53\",\n \"id\": 1442953,\n \"user_id\": \"5c6715fb-e9b9-e911-80d0-005056b1129c\",\n \"broker_id\": 664,\n \"custom_field_1\": \"https://brokerexample.com/auto_login/?username=990045988&password=Testing1\",\n \"location\": {\n \"ip\": \"86.129.129.34\",\n \"isoCode\": \"GB\",\n \"country\": \"United Kingdom\",\n \"city\": \"--\",\n \"postal_code\": \"--\",\n \"lat\": 52.0568,\n \"lon\": -0.8528,\n \"timezone\": \"Europe/London\",\n \"continent\": \"--\",\n \"lead_id\": 1442953,\n \"id\": 1438067\n }\n },\n \"extras\": {\n \"user_id\": \"5c6715fb-e9b9-e911-80d0-005056b1129c\",\n \"custom_field_1\": \"https://brokerexample.com/auto_login/?username=990045988&password=Testing1\",\n \"redirect\": {\n \"url\": \"https://brokerexample.com/auto_login/?username=990045988&password=Testing1\",\n \"method\": \"get\",\n \"secureConnection\": true,\n \"params\": []\n },\n \"broker_name\": \"Broker\",\n \"broker_id\": 664\n },\n \"broker\": {\n \"id\": 664,\n \"name\": \"Broker\",\n \"slug\": \"broker\",\n \"image1\": \"broker.png\",\n \"image2\": null\n }\n}"}],"_postman_id":"b4ef366a-d707-47a9-882e-5016bdd64516"},{"name":"Affiliate FTD check","id":"48be9d83-234f-486b-a7cd-ad9a5fbcdb18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://digitapi.net/affiliate_deposits/?token=12345&from=2019-07-28&to=2019-08-05&filter=ftd&limit=200","urlObject":{"protocol":"https","path":["affiliate_deposits",""],"host":["digitapi","net"],"query":[{"description":{"content":"Affiliate token. Provided to you by the staff.
\n","type":"text/plain"},"key":"token","value":"12345"},{"description":{"content":"Start date in interval (YYYY-mm-dd)
\n","type":"text/plain"},"key":"from","value":"2019-07-28"},{"description":{"content":"End date in interval (YYYY-mm-dd)
\n","type":"text/plain"},"key":"to","value":"2019-08-05"},{"description":{"content":"Optional parameter. Only fetch leads that made deposits. If this filter isn't provided a list of all registrations is returned
\n","type":"text/plain"},"key":"filter","value":"ftd"},{"description":{"content":"Optional parameter. Limit results, defaults to 200
\n","type":"text/plain"},"key":"limit","value":"200"}],"variable":[]}},"response":[{"id":"0f3f016c-f7c2-47f2-a12a-b7e96b61077f","name":"Invalid token","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://digitapi.net/affiliate_deposits/?token=12345&from=2019-07-28&to=2019-08-05&filter=ftd&limit=200","protocol":"https","host":["digitapi","net"],"path":["affiliate_deposits",""],"query":[{"key":"token","value":"12345","description":"Affiliate token. Provided to you by the staff."},{"key":"from","value":"2019-07-28","description":"Start date in interval (YYYY-mm-dd)"},{"key":"to","value":"2019-08-05","description":"End date in interval (YYYY-mm-dd)"},{"key":"filter","value":"ftd","description":"Optional parameter. Only fetch leads that made deposits."},{"key":"limit","value":"200","description":"Optional parameter. Limit results, defaults to 200"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.15.0"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Trace","value":"2B097BE9AEFF28E829D23D580EAF0A1192556A31D5DC0252B04B2D913701"},{"key":"Cache-Control","value":"no-cache"},{"key":"Date","value":"Tue, 13 Aug 2019 17:10:17 GMT"},{"key":"Set-Cookie","value":"laravel_session=ea07bbf930c0013b6acd6df46c0ef82d1495f0f3; path=/; HttpOnly"},{"key":"Content-Encoding","value":"gzip"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"194"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"\"Token invalid\""},{"id":"0e9e43b4-79a9-4f4e-ac21-3a97d04d8b4c","name":"Affiliate FTD check","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://digitapi.net/affiliate_deposits/?token=12345&from=2019-07-28&to=2019-08-05&filter=ftd&limit=200","protocol":"https","host":["digitapi","net"],"path":["affiliate_deposits",""],"query":[{"key":"token","value":"12345","description":"Affiliate token. Provided to you by the staff."},{"key":"from","value":"2019-07-28","description":"Start date in interval (YYYY-mm-dd)"},{"key":"to","value":"2019-08-05","description":"End date in interval (YYYY-mm-dd)"},{"key":"filter","value":"ftd","description":"Optional parameter. Only fetch leads that made deposits."},{"key":"limit","value":"200","description":"Optional parameter. Limit results, defaults to 200"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n\t{\n\t\t\"id\": 12345,\n\t\t\"hitid\": \"99886656\",\n\t\t\"funnel\": \"funnel_name\",\n\t\t\"broker_id\": 111,\n\t\t\"created_at\": \"2018-09-28 08:02:35\", \n\t\t\"first_time_deposit\": 2018-09-28 08:02:40 \n\t}, {\n\t\t\"id\": 12345,\n\t\t\"hitid\": \"99886657\",\n\t\t\"funnel\": \"funnel_name\",\n\t\t\"broker_id\": 112,\n\t\t\"created_at\": \"2018-09-28 09:09:35\", \n\t\t\"first_time_deposit\": 2018-10-01 10:02:30 \n\t},\n]"}],"_postman_id":"48be9d83-234f-486b-a7cd-ad9a5fbcdb18"}],"event":[{"listen":"prerequest","script":{"id":"41391448-81b4-49ad-9463-994a3d2d368c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"72da19ba-5433-4037-b249-94f5de9d98c3","type":"text/javascript","exec":[""]}}]}