Get started
Quickstart
Post a test lead, read it back, then send one we will call. About five minutes.
On this page
Export your key
Keep it server-side. Every request sends it as
Authorization: ApiKey ….terminalexport ENTROVOX_KEY="sk_entrovox_…"Post a test lead
"is_test": truestores the lead and nothing else. We never call or text it, it never blocks a later live lead on the same phone, and it stays out ofGET /v1/leads.curl -X POST https://api.entrovox.com/v1/leads \ -H "Authorization: ApiKey $ENTROVOX_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "first_name": "Test", "last_name": "Lead", "phone": "+15555550100", "external_id": "hw-1", "is_test": true }'import os, uuid, requests r = requests.post( "https://api.entrovox.com/v1/leads", headers={ "Authorization": f"ApiKey {os.environ['ENTROVOX_KEY']}", "Idempotency-Key": str(uuid.uuid4()), }, json={ "first_name": "Test", "last_name": "Lead", "phone": "+15555550100", "external_id": "hw-1", "is_test": True, }, timeout=15, ) lead = r.json()["data"] print(lead["status_url"]) # bookmark thisimport { randomUUID } from "node:crypto"; const res = await fetch("https://api.entrovox.com/v1/leads", { method: "POST", headers: { Authorization: `ApiKey ${process.env.ENTROVOX_KEY}`, "Idempotency-Key": randomUUID(), "Content-Type": "application/json", }, body: JSON.stringify({ first_name: "Test", last_name: "Lead", phone: "+15555550100", external_id: "hw-1", is_test: true, }), }); const { data: lead } = await res.json(); console.log(lead.status_url); // bookmark thisRead it back from the status URL
Every accepted lead returns a
status_url. It is the one place outcomes land: the lead-level disposition, then each call attempt with its transcript, recording and analysis.curl https://api.entrovox.com/v1/leads/7c2e1a90-2b1f-4d3a-9e0c-0b8c1d2e3f40 \ -H "Authorization: ApiKey $ENTROVOX_KEY"import os, requests r = requests.get( "https://api.entrovox.com/v1/leads/7c2e1a90-2b1f-4d3a-9e0c-0b8c1d2e3f40", headers={"Authorization": f"ApiKey {os.environ['ENTROVOX_KEY']}"}, timeout=15, ) print(r.json()["data"]["current_disposition"])const res = await fetch( "https://api.entrovox.com/v1/leads/7c2e1a90-2b1f-4d3a-9e0c-0b8c1d2e3f40", { headers: { Authorization: `ApiKey ${process.env.ENTROVOX_KEY}` } }, ); const { data: lead } = await res.json(); console.log(lead.current_disposition);200OK{ "data": { "id": "7c2e1a90-2b1f-4d3a-9e0c-0b8c1d2e3f40", "external_id": "hw-1", "current_disposition": "pending", "is_test": true, "calls": [] } }Send a live lead
Drop
is_testand use your own lead id. Qualified leads warm-transfer to the campaign number we set up with you. These are the fields to send:first_namestringRequiredWho to call. Not blank.
last_namestringRequiredWho to call. Not blank.
phonestringRequiredPhone in E.164, like
+14255551234.external_idstringRequiredYour lead id, unique per campaign. Makes retries safe.
zip_codestringOptional5-digit or ZIP+4. Sets the lead's timezone, which decides calling hours, when you send no
timezoneor USstate. Missing geography still accepts: we queue, we do not reject.trustedform_cert_urlstringOptionalTrustedForm certificate URL (
https://cert.trustedform.com/plus 40 hex characters). We check the format only: a malformed URL is400 CONSENT_INVALID, and you remain responsible for the certificate's validity.jornaya_leadidstringOptionalJornaya LeadiD. Stored, not validated.
metadataobjectOptionalYour own extras, echoed back on reads. These keys can help an AI voice agent the agency has set up verify lead details. Send them here, not at the top level.
Endpoints used
POST /v1/leads creates a lead. GET /v1/leads/{id} reads it back.
Next steps
Read Authentication and keys for what your key can reach, then Post a live lead for the full field list. Batch post takes 500 leads per request, Safe retries and idempotency says which codes to retry, and Webhooks will push outcomes instead of you polling.