v1.4

Altum Drive API

REST endpoints over HTTPS. JSON in, JSON out. Authenticate with a bearer token in the Authorization header.

curl https://api.altumdrive.com/v1/leads \
  -H "Authorization: Bearer alt_sk_live_xxxx" \
  -H "Content-Type: application/json"

bash

Authentication

POST

/v1/auth/login

Obtain a session token for a user.

Request

{
  "email": "user@altumdrive.com",
  "password": "•••"
}

json

Response

{
  "token": "alt_sk_...",
  "user": {
    "id": "u_1",
    "role": "bdc"
  }
}

json

POST

/v1/auth/logout

Revoke the current session token.

Response

{
  "ok": true
}

json

Leads

GET

/v1/leads

List leads with filters and pagination.

Response

{
  "data": [
    {
      "id": "L-1000",
      "name": "Jose Garcia",
      "score": 78,
      "filter": "A",
      "status": "new"
    }
  ],
  "page": 1,
  "total": 248
}

json

POST

/v1/leads

Create a new lead. The scoring engine runs synchronously.

Request

{
  "name": "Jose Garcia",
  "phone": "+17135550100",
  "creditScore": "good",
  "downPayment": 2000,
  "hasBank": true,
  "idType": "license",
  "tradeIn": true,
  "location": "houston"
}

json

Response

{
  "id": "L-1042",
  "score": 82,
  "filter": "A"
}

json

GET

/v1/leads/:id

Fetch a lead with full history.

Response

{
  "id": "L-1000",
  "name": "Jose Garcia",
  "messages": [],
  "activities": []
}

json

PATCH

/v1/leads/:id

Update lead fields (status, notes, etc).

Request

{
  "status": "appointment"
}

json

DELETE

/v1/leads/:id

Permanently delete a lead.

POST

/v1/whatsapp/messages

Send a WhatsApp message to a lead via 360dialog.

Request

{
  "leadId": "L-1000",
  "body": "Hola Jose..."
}

json

Response

{
  "id": "msg_x1",
  "status": "queued"
}

json

GET

/v1/whatsapp/threads/:leadId

Get the message thread for a lead.

POST

/v1/whatsapp/webhook

Inbound webhook from 360dialog. Configured at platform setup.

Inventory

GET

/v1/vehicles

List vehicles across locations.

POST

/v1/vehicles

Add a vehicle to inventory.

PATCH

/v1/vehicles/:id

Update price, status, miles.

Analytics

GET

/v1/analytics/summary

Aggregated KPIs by period and location.

Response

{
  "totalLeads": 248,
  "conv": 0.18,
  "avgScore": 54
}

json

GET

/v1/analytics/sources

Lead volume by source.

Rate limits

1,000 requests / minute per API key. 429 with Retry-After header when exceeded.