API Doc

POST Push Leads (Registration method)
Headers
Accept
application/json
FieldRequiredTypeStandardExample
email
(optional auto*)
+stringRFC[email protected]
phone+numberE.164 +44 20 1234 5678
full_name+stringJames Smith
ip
(optional auto*)
+stringIPv4192.158.1.38
landing+stringlanding
user_id+number1
country+stringISO 2UK
lang+stringEN
landing_name+stringtest_name
source+stringFB
description
(optional*)
-stringquiz
Example Request
curl --location 'https://crm.domain.live/api/leads' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "email": "[email protected]",
  "full_name": "Test Test",
  "landing": "domain.ru",
  "country": "IT",
  "landing_name": "Test-funnel",
  "user_id": 1,
  "source": "FB",
  "phone": "393895421210",
  "ip": "78.208.2.210",
  "description": "quiz"
}'
View more
Example Response
Body
{
  "status": true,
  "external_id": 1,
  "link_auto_login": "https://google.com",
  "lead_id": 1
}
No response headers
This request doesn't return any response headers
Get Leads list
Headers
Accept
application/json
Authorization
Bearer ТОКЕН
FieldRequiredTypeStandardExample
date_start+string2024-12-10
date_end+string2024-12-10
is_action
(additional req.for dep.*)
number1
pagenumber1
per_pagenumber100
Example Request
curl --location --request
  GET 'https://crm.yourdomain.net/api/web-master/leads' \
  --header 'Authorization: Bearer ТОКЕН' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "date_start": "2022-05-05",
  "date_end": "2022-05-05"
}'
View more
{
"ai": "ask from your trackbox partner",
"ci": "1",
"gi": "29.249.50.83",
}
Example Response
Body
 {
  "success": true,
  "data": {
    "data": [{
      "id": 1,
      "email": "[email protected]",
      "status": {
      "id": 1,
      "name": "New"
      },
      "is_action": 0,
      "action_time": "",
      "date": "2024-12-10 17:58:46"
    }],
  "current_page": 1,
  "total_pages": 1,
  "total": 1
  },
  "message": "Leads collection"
}
No response headers
This request doesn't return any response headers
© CRMate, 2024. All rights reserved.