Skip to main content
GET
Check iMessage Availability (Single Lead)
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 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

Query parameters

id
string
required
The lead’s ID (MongoDB ObjectId).Example: 667f1f77bcf86cd799439012

Example

Success response (200)

success
boolean
Always true on a 200 response.
leadId
string
The lead ID that was checked.
available
boolean
Whether the lead is reachable via iMessage.
status
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)
ghlContactId
string | null
GoHighLevel contact ID, if linked.
ghlLocationId
string | null
GoHighLevel location ID, if linked.
hsPortalId
string | null
HubSpot portal ID, if linked.
hsContactId
string | null
HubSpot contact ID, if linked.
The same status is written back to the lead, so you can also read it via the Leads API.

Error responses