Create Lead
curl --request POST \
--url https://eu-gcp-api.vg-stuff.com/v3/leads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"lead": {
"agentId": "<string>",
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"metaData": {
"address": "<string>",
"company": "<string>",
"website": "<string>",
"notes": "<string>",
"source": "chat",
"currency": "<string>",
"value": 123,
"expectedCloseDate": "<string>",
"subIndustry": "<string>",
"language": "<string>",
"linkedIn": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"demoDate": "<string>",
"demoTime": "<string>",
"demoLink": "<string>",
"lostReason": "<string>"
},
"hotScore": 123,
"lastActivityDate": "<string>",
"crmActivities": [
{
"id": "<string>",
"title": "<string>",
"date": "<string>",
"dueDate": "<string>",
"completed": true,
"responded": true,
"firstEngaged": true,
"secondEngaged": true,
"note": "<string>",
"notesHistory": [
{
"text": "<string>",
"agentId": "<string>",
"agentName": "<string>",
"timestamp": "<string>"
}
],
"metadata": {}
}
]
}
}
'import requests
url = "https://eu-gcp-api.vg-stuff.com/v3/leads"
payload = { "lead": {
"agentId": "<string>",
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"metaData": {
"address": "<string>",
"company": "<string>",
"website": "<string>",
"notes": "<string>",
"source": "chat",
"currency": "<string>",
"value": 123,
"expectedCloseDate": "<string>",
"subIndustry": "<string>",
"language": "<string>",
"linkedIn": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"demoDate": "<string>",
"demoTime": "<string>",
"demoLink": "<string>",
"lostReason": "<string>"
},
"hotScore": 123,
"lastActivityDate": "<string>",
"crmActivities": [
{
"id": "<string>",
"title": "<string>",
"date": "<string>",
"dueDate": "<string>",
"completed": True,
"responded": True,
"firstEngaged": True,
"secondEngaged": True,
"note": "<string>",
"notesHistory": [
{
"text": "<string>",
"agentId": "<string>",
"agentName": "<string>",
"timestamp": "<string>"
}
],
"metadata": {}
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
lead: {
agentId: '<string>',
email: '<string>',
name: '<string>',
phone: '<string>',
metaData: {
address: '<string>',
company: '<string>',
website: '<string>',
notes: '<string>',
source: 'chat',
currency: '<string>',
value: 123,
expectedCloseDate: '<string>',
subIndustry: '<string>',
language: '<string>',
linkedIn: '<string>',
facebook: '<string>',
instagram: '<string>',
demoDate: '<string>',
demoTime: '<string>',
demoLink: '<string>',
lostReason: '<string>'
},
hotScore: 123,
lastActivityDate: '<string>',
crmActivities: [
{
id: '<string>',
title: '<string>',
date: '<string>',
dueDate: '<string>',
completed: true,
responded: true,
firstEngaged: true,
secondEngaged: true,
note: '<string>',
notesHistory: [
{
text: '<string>',
agentId: '<string>',
agentName: '<string>',
timestamp: '<string>'
}
],
metadata: {}
}
]
}
})
};
fetch('https://eu-gcp-api.vg-stuff.com/v3/leads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eu-gcp-api.vg-stuff.com/v3/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'lead' => [
'agentId' => '<string>',
'email' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'metaData' => [
'address' => '<string>',
'company' => '<string>',
'website' => '<string>',
'notes' => '<string>',
'source' => 'chat',
'currency' => '<string>',
'value' => 123,
'expectedCloseDate' => '<string>',
'subIndustry' => '<string>',
'language' => '<string>',
'linkedIn' => '<string>',
'facebook' => '<string>',
'instagram' => '<string>',
'demoDate' => '<string>',
'demoTime' => '<string>',
'demoLink' => '<string>',
'lostReason' => '<string>'
],
'hotScore' => 123,
'lastActivityDate' => '<string>',
'crmActivities' => [
[
'id' => '<string>',
'title' => '<string>',
'date' => '<string>',
'dueDate' => '<string>',
'completed' => true,
'responded' => true,
'firstEngaged' => true,
'secondEngaged' => true,
'note' => '<string>',
'notesHistory' => [
[
'text' => '<string>',
'agentId' => '<string>',
'agentName' => '<string>',
'timestamp' => '<string>'
]
],
'metadata' => [
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://eu-gcp-api.vg-stuff.com/v3/leads"
payload := strings.NewReader("{\n \"lead\": {\n \"agentId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"metaData\": {\n \"address\": \"<string>\",\n \"company\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"source\": \"chat\",\n \"currency\": \"<string>\",\n \"value\": 123,\n \"expectedCloseDate\": \"<string>\",\n \"subIndustry\": \"<string>\",\n \"language\": \"<string>\",\n \"linkedIn\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"demoDate\": \"<string>\",\n \"demoTime\": \"<string>\",\n \"demoLink\": \"<string>\",\n \"lostReason\": \"<string>\"\n },\n \"hotScore\": 123,\n \"lastActivityDate\": \"<string>\",\n \"crmActivities\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"date\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"completed\": true,\n \"responded\": true,\n \"firstEngaged\": true,\n \"secondEngaged\": true,\n \"note\": \"<string>\",\n \"notesHistory\": [\n {\n \"text\": \"<string>\",\n \"agentId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"timestamp\": \"<string>\"\n }\n ],\n \"metadata\": {}\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://eu-gcp-api.vg-stuff.com/v3/leads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"lead\": {\n \"agentId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"metaData\": {\n \"address\": \"<string>\",\n \"company\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"source\": \"chat\",\n \"currency\": \"<string>\",\n \"value\": 123,\n \"expectedCloseDate\": \"<string>\",\n \"subIndustry\": \"<string>\",\n \"language\": \"<string>\",\n \"linkedIn\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"demoDate\": \"<string>\",\n \"demoTime\": \"<string>\",\n \"demoLink\": \"<string>\",\n \"lostReason\": \"<string>\"\n },\n \"hotScore\": 123,\n \"lastActivityDate\": \"<string>\",\n \"crmActivities\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"date\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"completed\": true,\n \"responded\": true,\n \"firstEngaged\": true,\n \"secondEngaged\": true,\n \"note\": \"<string>\",\n \"notesHistory\": [\n {\n \"text\": \"<string>\",\n \"agentId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"timestamp\": \"<string>\"\n }\n ],\n \"metadata\": {}\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu-gcp-api.vg-stuff.com/v3/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"lead\": {\n \"agentId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"metaData\": {\n \"address\": \"<string>\",\n \"company\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"source\": \"chat\",\n \"currency\": \"<string>\",\n \"value\": 123,\n \"expectedCloseDate\": \"<string>\",\n \"subIndustry\": \"<string>\",\n \"language\": \"<string>\",\n \"linkedIn\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"demoDate\": \"<string>\",\n \"demoTime\": \"<string>\",\n \"demoLink\": \"<string>\",\n \"lostReason\": \"<string>\"\n },\n \"hotScore\": 123,\n \"lastActivityDate\": \"<string>\",\n \"crmActivities\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"date\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"completed\": true,\n \"responded\": true,\n \"firstEngaged\": true,\n \"secondEngaged\": true,\n \"note\": \"<string>\",\n \"notesHistory\": [\n {\n \"text\": \"<string>\",\n \"agentId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"timestamp\": \"<string>\"\n }\n ],\n \"metadata\": {}\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": "<unknown>"
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Leads
Create Lead
Creates a new lead with the specified configuration, this route must use the new V3 endpoints.
POST
/
leads
Create Lead
curl --request POST \
--url https://eu-gcp-api.vg-stuff.com/v3/leads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"lead": {
"agentId": "<string>",
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"metaData": {
"address": "<string>",
"company": "<string>",
"website": "<string>",
"notes": "<string>",
"source": "chat",
"currency": "<string>",
"value": 123,
"expectedCloseDate": "<string>",
"subIndustry": "<string>",
"language": "<string>",
"linkedIn": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"demoDate": "<string>",
"demoTime": "<string>",
"demoLink": "<string>",
"lostReason": "<string>"
},
"hotScore": 123,
"lastActivityDate": "<string>",
"crmActivities": [
{
"id": "<string>",
"title": "<string>",
"date": "<string>",
"dueDate": "<string>",
"completed": true,
"responded": true,
"firstEngaged": true,
"secondEngaged": true,
"note": "<string>",
"notesHistory": [
{
"text": "<string>",
"agentId": "<string>",
"agentName": "<string>",
"timestamp": "<string>"
}
],
"metadata": {}
}
]
}
}
'import requests
url = "https://eu-gcp-api.vg-stuff.com/v3/leads"
payload = { "lead": {
"agentId": "<string>",
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"metaData": {
"address": "<string>",
"company": "<string>",
"website": "<string>",
"notes": "<string>",
"source": "chat",
"currency": "<string>",
"value": 123,
"expectedCloseDate": "<string>",
"subIndustry": "<string>",
"language": "<string>",
"linkedIn": "<string>",
"facebook": "<string>",
"instagram": "<string>",
"demoDate": "<string>",
"demoTime": "<string>",
"demoLink": "<string>",
"lostReason": "<string>"
},
"hotScore": 123,
"lastActivityDate": "<string>",
"crmActivities": [
{
"id": "<string>",
"title": "<string>",
"date": "<string>",
"dueDate": "<string>",
"completed": True,
"responded": True,
"firstEngaged": True,
"secondEngaged": True,
"note": "<string>",
"notesHistory": [
{
"text": "<string>",
"agentId": "<string>",
"agentName": "<string>",
"timestamp": "<string>"
}
],
"metadata": {}
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
lead: {
agentId: '<string>',
email: '<string>',
name: '<string>',
phone: '<string>',
metaData: {
address: '<string>',
company: '<string>',
website: '<string>',
notes: '<string>',
source: 'chat',
currency: '<string>',
value: 123,
expectedCloseDate: '<string>',
subIndustry: '<string>',
language: '<string>',
linkedIn: '<string>',
facebook: '<string>',
instagram: '<string>',
demoDate: '<string>',
demoTime: '<string>',
demoLink: '<string>',
lostReason: '<string>'
},
hotScore: 123,
lastActivityDate: '<string>',
crmActivities: [
{
id: '<string>',
title: '<string>',
date: '<string>',
dueDate: '<string>',
completed: true,
responded: true,
firstEngaged: true,
secondEngaged: true,
note: '<string>',
notesHistory: [
{
text: '<string>',
agentId: '<string>',
agentName: '<string>',
timestamp: '<string>'
}
],
metadata: {}
}
]
}
})
};
fetch('https://eu-gcp-api.vg-stuff.com/v3/leads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eu-gcp-api.vg-stuff.com/v3/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'lead' => [
'agentId' => '<string>',
'email' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'metaData' => [
'address' => '<string>',
'company' => '<string>',
'website' => '<string>',
'notes' => '<string>',
'source' => 'chat',
'currency' => '<string>',
'value' => 123,
'expectedCloseDate' => '<string>',
'subIndustry' => '<string>',
'language' => '<string>',
'linkedIn' => '<string>',
'facebook' => '<string>',
'instagram' => '<string>',
'demoDate' => '<string>',
'demoTime' => '<string>',
'demoLink' => '<string>',
'lostReason' => '<string>'
],
'hotScore' => 123,
'lastActivityDate' => '<string>',
'crmActivities' => [
[
'id' => '<string>',
'title' => '<string>',
'date' => '<string>',
'dueDate' => '<string>',
'completed' => true,
'responded' => true,
'firstEngaged' => true,
'secondEngaged' => true,
'note' => '<string>',
'notesHistory' => [
[
'text' => '<string>',
'agentId' => '<string>',
'agentName' => '<string>',
'timestamp' => '<string>'
]
],
'metadata' => [
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://eu-gcp-api.vg-stuff.com/v3/leads"
payload := strings.NewReader("{\n \"lead\": {\n \"agentId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"metaData\": {\n \"address\": \"<string>\",\n \"company\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"source\": \"chat\",\n \"currency\": \"<string>\",\n \"value\": 123,\n \"expectedCloseDate\": \"<string>\",\n \"subIndustry\": \"<string>\",\n \"language\": \"<string>\",\n \"linkedIn\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"demoDate\": \"<string>\",\n \"demoTime\": \"<string>\",\n \"demoLink\": \"<string>\",\n \"lostReason\": \"<string>\"\n },\n \"hotScore\": 123,\n \"lastActivityDate\": \"<string>\",\n \"crmActivities\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"date\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"completed\": true,\n \"responded\": true,\n \"firstEngaged\": true,\n \"secondEngaged\": true,\n \"note\": \"<string>\",\n \"notesHistory\": [\n {\n \"text\": \"<string>\",\n \"agentId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"timestamp\": \"<string>\"\n }\n ],\n \"metadata\": {}\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://eu-gcp-api.vg-stuff.com/v3/leads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"lead\": {\n \"agentId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"metaData\": {\n \"address\": \"<string>\",\n \"company\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"source\": \"chat\",\n \"currency\": \"<string>\",\n \"value\": 123,\n \"expectedCloseDate\": \"<string>\",\n \"subIndustry\": \"<string>\",\n \"language\": \"<string>\",\n \"linkedIn\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"demoDate\": \"<string>\",\n \"demoTime\": \"<string>\",\n \"demoLink\": \"<string>\",\n \"lostReason\": \"<string>\"\n },\n \"hotScore\": 123,\n \"lastActivityDate\": \"<string>\",\n \"crmActivities\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"date\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"completed\": true,\n \"responded\": true,\n \"firstEngaged\": true,\n \"secondEngaged\": true,\n \"note\": \"<string>\",\n \"notesHistory\": [\n {\n \"text\": \"<string>\",\n \"agentId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"timestamp\": \"<string>\"\n }\n ],\n \"metadata\": {}\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu-gcp-api.vg-stuff.com/v3/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"lead\": {\n \"agentId\": \"<string>\",\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"metaData\": {\n \"address\": \"<string>\",\n \"company\": \"<string>\",\n \"website\": \"<string>\",\n \"notes\": \"<string>\",\n \"source\": \"chat\",\n \"currency\": \"<string>\",\n \"value\": 123,\n \"expectedCloseDate\": \"<string>\",\n \"subIndustry\": \"<string>\",\n \"language\": \"<string>\",\n \"linkedIn\": \"<string>\",\n \"facebook\": \"<string>\",\n \"instagram\": \"<string>\",\n \"demoDate\": \"<string>\",\n \"demoTime\": \"<string>\",\n \"demoLink\": \"<string>\",\n \"lostReason\": \"<string>\"\n },\n \"hotScore\": 123,\n \"lastActivityDate\": \"<string>\",\n \"crmActivities\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"date\": \"<string>\",\n \"dueDate\": \"<string>\",\n \"completed\": true,\n \"responded\": true,\n \"firstEngaged\": true,\n \"secondEngaged\": true,\n \"note\": \"<string>\",\n \"notesHistory\": [\n {\n \"text\": \"<string>\",\n \"agentId\": \"<string>\",\n \"agentName\": \"<string>\",\n \"timestamp\": \"<string>\"\n }\n ],\n \"metadata\": {}\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": "<unknown>"
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Example Request
{
"lead": {
"agentId": "your_agent_id",
"name": "John Doe",
"email": "john@example.com",
"phone": "+1234567890",
"metaData": {
"company": "Acme Inc",
"source": "api",
"notes": "Interested in enterprise plan"
}
}
}
agentId is required. At least one contact field (email, phone, or name) is recommended.Use the
metaData.source field to track where leads come from (e.g., ‘chat’, ‘web’, ‘api’, ‘import’).⌘I
