Leads
Create a lead
Creates a new lead in the account.
POST
/
api
/
v1
/
accounts
/
{account_id}
/
leads
Create a lead
curl --request POST \
--url https://connect.voxys.ai/api/v1/accounts/{account_id}/leads \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"custom_name": "Enterprise Deal - Q3",
"lead_value": 15000,
"lead_currency": "USD",
"assigned_agent_id": 1,
"position": 1,
"conversation_id": 100,
"company_id": 10,
"custom_attributes": {
"industry": "Technology",
"annual_revenue": 500000
}
}
'import requests
url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/leads"
payload = {
"custom_name": "Enterprise Deal - Q3",
"lead_value": 15000,
"lead_currency": "USD",
"assigned_agent_id": 1,
"position": 1,
"conversation_id": 100,
"company_id": 10,
"custom_attributes": {
"industry": "Technology",
"annual_revenue": 500000
}
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
custom_name: 'Enterprise Deal - Q3',
lead_value: 15000,
lead_currency: 'USD',
assigned_agent_id: 1,
position: 1,
conversation_id: 100,
company_id: 10,
custom_attributes: {industry: 'Technology', annual_revenue: 500000}
})
};
fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/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://connect.voxys.ai/api/v1/accounts/{account_id}/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([
'custom_name' => 'Enterprise Deal - Q3',
'lead_value' => 15000,
'lead_currency' => 'USD',
'assigned_agent_id' => 1,
'position' => 1,
'conversation_id' => 100,
'company_id' => 10,
'custom_attributes' => [
'industry' => 'Technology',
'annual_revenue' => 500000
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);
$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://connect.voxys.ai/api/v1/accounts/{account_id}/leads"
payload := strings.NewReader("{\n \"custom_name\": \"Enterprise Deal - Q3\",\n \"lead_value\": 15000,\n \"lead_currency\": \"USD\",\n \"assigned_agent_id\": 1,\n \"position\": 1,\n \"conversation_id\": 100,\n \"company_id\": 10,\n \"custom_attributes\": {\n \"industry\": \"Technology\",\n \"annual_revenue\": 500000\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_token", "<api-key>")
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://connect.voxys.ai/api/v1/accounts/{account_id}/leads")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"custom_name\": \"Enterprise Deal - Q3\",\n \"lead_value\": 15000,\n \"lead_currency\": \"USD\",\n \"assigned_agent_id\": 1,\n \"position\": 1,\n \"conversation_id\": 100,\n \"company_id\": 10,\n \"custom_attributes\": {\n \"industry\": \"Technology\",\n \"annual_revenue\": 500000\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"custom_name\": \"Enterprise Deal - Q3\",\n \"lead_value\": 15000,\n \"lead_currency\": \"USD\",\n \"assigned_agent_id\": 1,\n \"position\": 1,\n \"conversation_id\": 100,\n \"company_id\": 10,\n \"custom_attributes\": {\n \"industry\": \"Technology\",\n \"annual_revenue\": 500000\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"custom_name": "Enterprise Deal - Q3",
"status": "open",
"lead_value": 15000,
"lead_currency": "USD",
"position": 1,
"notes": "Prospect from trade show",
"assigned_agent": {
"id": 1,
"name": "Jane Smith",
"email": "jane@example.com",
"avatar_url": "<string>"
},
"company": {
"id": 10,
"name": "Acme Corp",
"domain": "acme.com"
},
"conversation_id": 100,
"custom_attributes": {
"industry": "Technology",
"annual_revenue": 500000
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Unauthorized"
}{
"errors": {
"name": [
"can't be blank"
]
}
}Authorizations
API access token for authentication. Obtain from your Voxys Connect profile settings.
Path Parameters
The numeric ID of the account.
Body
application/json
Example:
"Enterprise Deal - Q3"
Example:
15000
Example:
"USD"
Example:
1
Example:
1
Example:
100
Example:
10
Flexible key-value map of custom attributes defined for the account.
Example:
{
"industry": "Technology",
"annual_revenue": 500000
}
Response
Lead created successfully.
Example:
42
Example:
"Enterprise Deal - Q3"
Available options:
open, won, lost, snoozed Example:
"open"
Example:
15000
Example:
"USD"
Example:
1
Example:
"Prospect from trade show"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
100
Flexible key-value map of custom attributes defined for the account.
Example:
{
"industry": "Technology",
"annual_revenue": 500000
}
⌘I
Create a lead
curl --request POST \
--url https://connect.voxys.ai/api/v1/accounts/{account_id}/leads \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"custom_name": "Enterprise Deal - Q3",
"lead_value": 15000,
"lead_currency": "USD",
"assigned_agent_id": 1,
"position": 1,
"conversation_id": 100,
"company_id": 10,
"custom_attributes": {
"industry": "Technology",
"annual_revenue": 500000
}
}
'import requests
url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/leads"
payload = {
"custom_name": "Enterprise Deal - Q3",
"lead_value": 15000,
"lead_currency": "USD",
"assigned_agent_id": 1,
"position": 1,
"conversation_id": 100,
"company_id": 10,
"custom_attributes": {
"industry": "Technology",
"annual_revenue": 500000
}
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
custom_name: 'Enterprise Deal - Q3',
lead_value: 15000,
lead_currency: 'USD',
assigned_agent_id: 1,
position: 1,
conversation_id: 100,
company_id: 10,
custom_attributes: {industry: 'Technology', annual_revenue: 500000}
})
};
fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/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://connect.voxys.ai/api/v1/accounts/{account_id}/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([
'custom_name' => 'Enterprise Deal - Q3',
'lead_value' => 15000,
'lead_currency' => 'USD',
'assigned_agent_id' => 1,
'position' => 1,
'conversation_id' => 100,
'company_id' => 10,
'custom_attributes' => [
'industry' => 'Technology',
'annual_revenue' => 500000
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);
$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://connect.voxys.ai/api/v1/accounts/{account_id}/leads"
payload := strings.NewReader("{\n \"custom_name\": \"Enterprise Deal - Q3\",\n \"lead_value\": 15000,\n \"lead_currency\": \"USD\",\n \"assigned_agent_id\": 1,\n \"position\": 1,\n \"conversation_id\": 100,\n \"company_id\": 10,\n \"custom_attributes\": {\n \"industry\": \"Technology\",\n \"annual_revenue\": 500000\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_token", "<api-key>")
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://connect.voxys.ai/api/v1/accounts/{account_id}/leads")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"custom_name\": \"Enterprise Deal - Q3\",\n \"lead_value\": 15000,\n \"lead_currency\": \"USD\",\n \"assigned_agent_id\": 1,\n \"position\": 1,\n \"conversation_id\": 100,\n \"company_id\": 10,\n \"custom_attributes\": {\n \"industry\": \"Technology\",\n \"annual_revenue\": 500000\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"custom_name\": \"Enterprise Deal - Q3\",\n \"lead_value\": 15000,\n \"lead_currency\": \"USD\",\n \"assigned_agent_id\": 1,\n \"position\": 1,\n \"conversation_id\": 100,\n \"company_id\": 10,\n \"custom_attributes\": {\n \"industry\": \"Technology\",\n \"annual_revenue\": 500000\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"custom_name": "Enterprise Deal - Q3",
"status": "open",
"lead_value": 15000,
"lead_currency": "USD",
"position": 1,
"notes": "Prospect from trade show",
"assigned_agent": {
"id": 1,
"name": "Jane Smith",
"email": "jane@example.com",
"avatar_url": "<string>"
},
"company": {
"id": 10,
"name": "Acme Corp",
"domain": "acme.com"
},
"conversation_id": 100,
"custom_attributes": {
"industry": "Technology",
"annual_revenue": 500000
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Unauthorized"
}{
"errors": {
"name": [
"can't be blank"
]
}
}
