Skip to content

Get started

Quickstart

Post a test lead, read it back, then send one we will call. About five minutes.

On this page
  1. Export your key

    Keep it server-side. Every request sends it as Authorization: ApiKey ….

    terminal
    export ENTROVOX_KEY="sk_entrovox_…"
  2. Post a test lead

    "is_test": true stores 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 of GET /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
      }'
  3. Read 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"
    200OK
    {
      "data": {
        "id": "7c2e1a90-2b1f-4d3a-9e0c-0b8c1d2e3f40",
        "external_id": "hw-1",
        "current_disposition": "pending",
        "is_test": true,
        "calls": []
      }
    }
  4. Send a live lead

    Drop is_test and 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_namestringRequired

    Who to call. Not blank.

    last_namestringRequired

    Who to call. Not blank.

    phonestringRequired

    Phone in E.164, like +14255551234.

    external_idstringRequired

    Your lead id, unique per campaign. Makes retries safe.

    zip_codestringOptional

    5-digit or ZIP+4. Sets the lead's timezone, which decides calling hours, when you send no timezone or US state. Missing geography still accepts: we queue, we do not reject.

    trustedform_cert_urlstringOptional

    TrustedForm certificate URL (https://cert.trustedform.com/ plus 40 hex characters). We check the format only: a malformed URL is 400 CONSENT_INVALID, and you remain responsible for the certificate's validity.

    jornaya_leadidstringOptional

    Jornaya LeadiD. Stored, not validated.

    metadataobjectOptional

    Your 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.

Updated Nov 7, 2026