Shared Fields

Reference for all common field types used across multiple Logimeter API endpoints. These types appear in request bodies, response objects, and webhook payloads throughout the API.

Company

Identifies a partner company by name and reference. The name and reference must match a registered Partner Company Reference (PCR) in Logimeter.

{"name": "Cape Town Dealer", "reference": "dealer-cape-town-001"}

Contact

References a registered partner contact — typically a sales agent or team member.

{"name": "Jane Smith", "reference": "agent-jane-001"}

PhoneNumber

Phone numbers must be in E.164 format without the leading +. This means country code followed directly by the subscriber number with no spaces, hyphens, or brackets.

DateTime

All datetime values use ISO 8601 format with a timezone offset. The Logimeter platform operates in SAST (UTC+2).

"2026-01-15T09:30:00+02:00"

Always include the offset. Do not send naive (offset-free) datetimes. When storing datetimes in your system, preserve the offset or convert to UTC explicitly.

TimeField

Time values (e.g. for business hours) use 24-hour HH:MM:SS format.

CallTermCallbackUrl

An HTTPS URL on your server that receives a POST request containing call data when a tracked call ends. On DNA and Connect endpoints, pass an array of URLs as call_term_callbacks (the singular call_term_callback field was removed). AutoConnect lead outcomes use autoconnect_callback_url on partner features instead.

• Must be an HTTPS URL accessible from the internet.
• Must respond with HTTP 200 within 10 seconds.
• Should return 200 immediately and process the payload asynchronously.

See Webhooks & Callbacks for the full payload specification and retry policy.

integration_active

Boolean flag on v2 Call Manager company, contact, call group, and business-hours resources. Controls whether the resource participates in live call routing. Toggling it may trigger support notification emails. Not used on DNA tracking numbers.

Deprecated Fields

TrackingNumberFeatures

An object controlling alert and notification features for a TrackingNumber. All fields are optional — omit any you do not need.

{
  "lead_alert_email": ["manager@example.com"],
  "lead_alert_sms": ["27821234567"],
  "missed_call_alert_email": ["support@example.com"],
  "missed_call_alert_sms": [],
  "missed_call_response": {
    "text": "Sorry we missed your call.",
    "enabled": true
  },
  "meeting_tracker_enabled": false
}

LeadVehicle

Optional vehicle data sent with DNA (Dynamic Number Allocation) requests. Provides context about the lead's vehicle interest.

{
  "received_time": "2026-01-15T09:00:00+02:00",
  "id": "lead-id-123",
  "sales_executive": {
    "id": "exec-1",
    "name": "Jane",
    "surname": "Smith"
  },
  "source": {},
  "prospect": {},
  "vehicle": {},
  "trade_in": {}
}

StockItem

References a specific stock item (vehicle) with an optional details object.

{
  "reference": "stock-uuid",
  "details": {
    "brand": "Toyota",
    "colour": "Silver"
  }
}

Unstructured

A free-form key-value map where both keys and values are strings. Used in StockItem.details and other extensible fields. There is no fixed schema — include whatever attributes are relevant to your use case.

{
  "brand": "Toyota",
  "model": "Corolla",
  "colour": "Silver",
  "year": "2024",
  "transmission": "Automatic"
}