Leads
Change lead status
Changes the status of a lead (e.g., open, won, lost, snoozed) with optional notes.
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
leads
/
{id}
/
status
Change lead status
curl --request PATCH \
--url https://connect.voxys.ai/api/v1/accounts/{account_id}/leads/{id}/status \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"status": "won",
"notes": "Closed deal after final negotiation."
}
'import requests
url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/leads/{id}/status"
payload = {
"status": "won",
"notes": "Closed deal after final negotiation."
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'won', notes: 'Closed deal after final negotiation.'})
};
fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/leads/{id}/status', 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/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'won',
'notes' => 'Closed deal after final negotiation.'
]),
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/{id}/status"
payload := strings.NewReader("{\n \"status\": \"won\",\n \"notes\": \"Closed deal after final negotiation.\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://connect.voxys.ai/api/v1/accounts/{account_id}/leads/{id}/status")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"won\",\n \"notes\": \"Closed deal after final negotiation.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/leads/{id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"won\",\n \"notes\": \"Closed deal after final negotiation.\"\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"
}{
"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.
The ID of the lead.
Body
application/json
Response
Status updated.
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
Change lead status
curl --request PATCH \
--url https://connect.voxys.ai/api/v1/accounts/{account_id}/leads/{id}/status \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"status": "won",
"notes": "Closed deal after final negotiation."
}
'import requests
url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/leads/{id}/status"
payload = {
"status": "won",
"notes": "Closed deal after final negotiation."
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'won', notes: 'Closed deal after final negotiation.'})
};
fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/leads/{id}/status', 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/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'won',
'notes' => 'Closed deal after final negotiation.'
]),
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/{id}/status"
payload := strings.NewReader("{\n \"status\": \"won\",\n \"notes\": \"Closed deal after final negotiation.\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://connect.voxys.ai/api/v1/accounts/{account_id}/leads/{id}/status")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"won\",\n \"notes\": \"Closed deal after final negotiation.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/leads/{id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"won\",\n \"notes\": \"Closed deal after final negotiation.\"\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"
}{
"error": "Unauthorized"
}{
"errors": {
"name": [
"can't be blank"
]
}
}
