Check iMessage Availability (Single Lead)
curl --request GET \
--url https://app.tuco.ai/api/leads/check-availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.tuco.ai/api/leads/check-availability"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.tuco.ai/api/leads/check-availability', 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://app.tuco.ai/api/leads/check-availability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.tuco.ai/api/leads/check-availability"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.tuco.ai/api/leads/check-availability")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.tuco.ai/api/leads/check-availability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"leadId": "<string>",
"available": true,
"status": "<string>",
"ghlContactId": {},
"ghlLocationId": {},
"hsPortalId": {},
"hsContactId": {}
}iMessage Availability
Check iMessage Availability (Single Lead)
Check if a specific lead is reachable via iMessage. REST endpoint in the Tuco AI iMessage API — bearer-token auth, JSON request/response, full schema and code.
GET
/
api
/
leads
/
check-availability
Check iMessage Availability (Single Lead)
curl --request GET \
--url https://app.tuco.ai/api/leads/check-availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.tuco.ai/api/leads/check-availability"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.tuco.ai/api/leads/check-availability', 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://app.tuco.ai/api/leads/check-availability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.tuco.ai/api/leads/check-availability"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.tuco.ai/api/leads/check-availability")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.tuco.ai/api/leads/check-availability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"leadId": "<string>",
"available": true,
"status": "<string>",
"ghlContactId": {},
"ghlLocationId": {},
"hsPortalId": {},
"hsContactId": {}
}Check iMessage availability for a single lead using their stored phone numbers and emails. Tuco checks every address on the lead (phone, email, altPhone1-3, altEmail1-3) and stops at the first one that is iMessage-capable. Updates the lead’s
The same status is written back to the lead, so you can also read it via the Leads API.
availabilityStatus field.
Don’t have a lead ID? Use
GET /api/check-availability?address=+12025551234 to check any phone or email directly. No saved lead required.Authentication
Authorization: Bearer tuco_sk_xxxxxxxxxxxxx
Query parameters
string
required
The lead’s ID (MongoDB ObjectId).Example:
667f1f77bcf86cd799439012Example
curl "https://app.tuco.ai/api/leads/check-availability?id=667f1f77bcf86cd799439012" \
-H "Authorization: Bearer tuco_sk_xxxxxxxxxxxxx"
Success response (200)
{
"success": true,
"leadId": "667f1f77bcf86cd799439012",
"available": true,
"status": "available",
"ghlContactId": "aMUQn0u0Z7cw0NQ7tJ5R",
"ghlLocationId": "eL7DD22BdZ0rismu7qCA",
"hsPortalId": null,
"hsContactId": null
}
boolean
Always
true on a 200 response.string
The lead ID that was checked.
boolean
Whether the lead is reachable via iMessage.
string
One of:
"available"— at least one stored address supports iMessage"unavailable"— none of the stored addresses support iMessage"error"— the check failed (temporary issue)
string | null
GoHighLevel contact ID, if linked.
string | null
GoHighLevel location ID, if linked.
string | null
HubSpot portal ID, if linked.
string | null
HubSpot contact ID, if linked.
Error responses
| Status | When | Body |
|---|---|---|
400 | Missing id parameter | { "error": "Lead ID is required" } |
401 | Invalid or missing API key | { "error": "Unauthorized" } |
404 | Lead not found | { "error": "Lead not found" } |
429 | API rate limit exceeded (200 req/min) | { "error": "Rate limit exceeded" } |
429 | All lines hit daily cap (70/day/line) | { "error": "Daily availability check quota exhausted" } |
500 | Internal server error | { "error": "Internal server error" } |