Lead API for Integration Partners
Version 1 · Last updated: 5 November 2026
Lead providers, dialers, forms and automation tools can deliver leads straight into an agent's AVEX RE account. Each lead becomes a contact, is matched against people the agent already has, and is added to the agent's Call List. The request format follows Follow Up Boss's /v1/events, so an existing Follow Up Boss integration needs only a new URL and key.
1. Authentication
The agent creates an API key in AVEX RE under Settings → Integrations and pastes it into your product. Keys start with avex_ and belong to one agent; everything sent with a key goes to that agent only. Send it in any of these ways:
Authorization: Bearer avex_...Authorization: Basicwith the key as the username and an empty password (Follow Up Boss style)X-API-Key: avex_...
2. Test the connection
GET /api/leads/me confirms the key and returns the account it belongs to. It creates nothing, so it is safe for a “Connect” or “Test” button.
curl https://avexre.ai/api/leads/me -H "Authorization: Bearer avex_..."
# 200 {"ok":true,"account":"agent@example.com","keyName":"REDX"}3. Send a lead
POST /api/leads/events with a JSON body (max 64 KB). One lead per request. A lead needs at least one phone number or email address.
curl -X POST https://avexre.ai/api/leads/events \
-H "Authorization: Bearer avex_..." \
-H "Content-Type: application/json" \
-d '{
"source": "REDX",
"type": "Expired",
"externalId": "redx-102938",
"message": "Expired 10/31/2026 after 94 days. Original list $525,000.",
"person": {
"firstName": "Jane",
"lastName": "Doe",
"emails": [{ "value": "jane@example.com" }],
"phones": [
{ "value": "(305) 555-0101", "dnc": false },
{ "value": "(305) 555-0102", "dnc": true }
],
"tags": ["Expired"]
},
"property": {
"street": "123 Main St",
"city": "Miami",
"state": "FL",
"code": "33101",
"price": 525000,
"mlsNumber": "A11223344"
}
}'Fields
| Field | Type | Description |
|---|---|---|
source | string | Who sent the lead, e.g. "REDX", "Landvoice", "Mojo", "my +plus leads". Shown on the contact and in Lead Source reports. |
type | string | Lead kind: Expired, FSBO, FRBO, Pre-Foreclosure, Withdrawn, Cancelled, Absentee Owner, Probate, or an inquiry type. |
externalId | string | Your record id. A retry with the same id is stored once. |
message | string | Free text added to the contact's timeline (status, dates, notes). |
person.firstName / lastName / name | string | Owner or lead name. |
person.emails[].value | string | One or more email addresses. |
person.phones[].value | string | Up to 6 numbers, in any US format. |
person.phones[].dnc | boolean | true if the number is on a Do Not Call list. AVEX will not let the agent dial it. |
person.tags[] | string[] | Up to 10 tags. A lead kind in tags ("FSBO") sets the kind. |
property.street / city / state / code | string | Property address. A single "address" string also works. |
property.price / mlsNumber / url | number / string | List or asking price, MLS number, listing link. |
A flat body also works: { "name", "email", "phone", "address", "message", "source", "type" }.
Responses
201{ "id", "created": true }new contact.200{ "id", "created": false }matched an existing contact by id, email, phone or address; the new details are added to it.400body is not a lead (the error says why).401missing, invalid or revoked key.413body too large.5xxretry with the sameexternalId. Retries never create duplicates.
4. Other ways in
- Zapier. Use a “Webhooks by Zapier” POST to the endpoint above, with the key in the Authorization header.
- Daily lead email. Each agent has a private intake address in Settings → Integrations. A daily lead email sent or forwarded there is read and imported.
- CSV. Agents can upload an export file; AVEX recognises the column layout of the major lead providers.
5. Compliance
AVEX never dials a lead automatically. Numbers flagged dnc: true are shown as Do Not Call and blocked from dialing. Please send your Do Not Call flag with every number. The agent who owns the key is responsible for how the leads are contacted under the TCPA and state law, as set out in our terms.
6. Partner program
To list AVEX RE as a destination in your product, or to get a sandbox account, email support@avexre.ai.