Fields

Request fields

Fields accepted on POST /v1/connect/. See also Connect API for examples and validation errors.

Field	Type	Required	Default	Description
company	object	required	—	Dealership this Connect belongs to. `company.reference` routes and attributes the lead.
leg_a	array	conditional	—	Agent legs — called first, hear whisper, must confirm. Required unless `vehicle.new_used` is supplied with `CALL_ALL`, `HEAD_START`, or `SEQUENTIAL` (see optional leg_a).
leg_b	array	required	—	Customer / prospect legs. At least one entry with `number`. Only one B-leg is typical.
name	string	optional	`""`	Friendly description of this lead, e.g. Blue 2008 Citi Golf.
reference	string	optional	`""`	Your unique ID for this request. Strongly recommended — used to link call events, enable partner safety-net checks, and avoid duplicate retries.
call_distribution	string	optional	`SINGLE`	How to distribute among `leg_a` agents. See CallDistribution.
call_term_callbacks	array of URLs	optional	`[]`	HTTPS URLs on your server for call-event webhooks. Unioned with partner/company callbacks configured in Logimeter (see Call Events).
connect_type	string	optional	`LEAD_CONNECT`	Category of Connect. See ConnectType.
recorded	boolean	optional	partner default (`true`)	Whether calls are recorded. If omitted, uses `partner_features.leadconnect_recorded_default` (typically `true`). Send `false` explicitly to override.
whisper	string	optional	`""`	Text converted to speech and played to leg A before confirmation. When omitted, no custom whisper string is sent; dialplan/partner settings may still play prompts.
vehicle	object	conditional	—	Required when omitting `leg_a` (with eligible `call_distribution`). See Vehicle.
locale	string	optional	`en-US`	Language accent for TTS whisper/prompt generation when no `voice` is set.
voice	string	optional	`Amy`	Text-to-speech voice for whisper/prompt audio.
lead_source	string	optional	`null`	Source name identifying where this lead originated (reporting/attribution).

Contact leg_a[]

Writable

Field	Type	Required	Description
number	PhoneNumber	required	International digits only — no `+` or leading `0`. Length 9–15 (Ireland `353`: 8–15). Must match a prefix enabled for your partner account.
name	string	required	Agent full name for reporting. Cannot be blank.
reference	string	required	Your unique ID for this agent (CRM contact ID, employee code, etc.).
order	integer	optional	Dial order for `SEQUENTIAL` only. If any leg has `order`, every leg must have a unique value `>= 1`. Ignored for other distributions. Responses return `order` as 1-based.

CallLeg leg_b[]

Note: Same shape as Contact but name and reference are optional.

Writable

Field	Type	Required	Description
number	PhoneNumber	required	Customer phone number. Same format rules as leg A.
name	string	optional	Customer name for reporting. Default `""`.
reference	string	optional	Your identifier for this customer. Default `""`.

Read-only (in responses)

Field	Type	Description
confirmed	boolean	Whether leg A confirmed (e.g. pressed 1).
bridged	boolean	Whether leg A and leg B were connected.
dial_stamp	datetime	When this leg was dialled (UTC).
answer_stamp	datetime	When this leg was answered (UTC).
end_stamp	datetime	When this leg ended (UTC).
order	integer	1-based dial order in API responses.

CallDistribution

Value	Description
SINGLE	Exactly one `leg_a` entry. That agent is called.
FIRST	Deprecated. Only the first `leg_a` number is used. Prefer `SINGLE` with one leg.
CALL_ALL	All `leg_a` numbers are called simultaneously. First agent to answer and press 1 is connected to leg B. Requires at least 1 A-leg (or call-group resolution via `vehicle`).
HEAD_START	One random `leg_a` is called first; others are delayed (default 10 seconds, configurable per system/partner/company). First to answer and press 1 wins. Requires at least 1 A-leg.
SEQUENTIAL	A-legs are dialled in `order` sequence (or enumerate order). Between 1 and N A-legs where N is `company.features.sequential_connect_max_leg_a_count` (default 10).

ROUND_ROBIN exists internally but is not accepted on POST /v1/connect/. Implement round-robin in your LMS using repeated SINGLE requests — see Round Robin Distribution.

Optional leg_a via vehicle

Omit leg_a only when all of the following are true:

call_distribution is CALL_ALL, HEAD_START, or SEQUENTIAL
vehicle.new_used is NEW or USED
The company has the matching call group configured in Logimeter (connect_callall_new_callgroup or connect_callall_used_callgroup) with available contacts

Logimeter builds the effective leg_a list from that call group. Common errors: Company Vehicle New CallGroup for CALL_ALL not set, CallGroup:{name} has no available contacts.

ConnectType

Value	Description
LEAD_CONNECT	Standard lead Connect (default).
FOLLOW_UP	Follow-up Connect request.
PLEASE_CALL_ME	Please-call-me style request.
CSI	Customer satisfaction / CSI flows.
MISSED_CALL_SAVER	Missed-call saver callback.
CLICK_TO_CALL	Click-to-call initiated Connect.
AUTOCONNECT	AutoConnect pipeline (usually set internally).
PARTS / SERVICE / CAMPAIGN / …	Additional types may be provisioned per partner. Contact Logimeter if you need a specific type.

ConnectState

Returned as state on Connect resources and nested under leadconnect.state in call events.

state.name	Description
FAILED	Internal/PSTN failure when placing the call.
PENDING	Call in progress. Contact support if stuck (~2 hours).
A_NOT_ANSWERED	Leg A was dialled but did not answer.
A_NOT_CONFIRMED	Leg A answered but did not confirm within one minute.
A_CANCELLED	Leg A confirmed then hung up before leg B connected.
B_NOT_ANSWERED	Leg A confirmed; leg B did not answer.
OK	Conversation occurred; check `talk_duration` (voicemail possible).

Vehicle

Field	Type	Required	Description
new_used	string	required when using vehicle	`NEW` or `USED` — selects which call group resolves optional `leg_a`.
brand	string	optional	Vehicle brand name. Must exist in Logimeter's brand catalogue or API returns `Vehicle Brand {name} does not exist`.

Response-only fields

Present on 201 Created, GET /v1/connect/, and GET /v1/connect/{uuid}/:

Field	Type	When present
url	string	API URL for this Connect resource.
uuid	string	Unique Connect identifier.
create_stamp / modify_stamp	datetime	UTC timestamps.
state	ConnectState	Current outcome (`PENDING` on successful create).
calls	array	Call IDs linked to this Connect (empty initially).
confirmed_call	array	Call ID where agent pressed 1 first (multi-agent modes).
callall_callgroup	object	Call group used when `leg_a` was resolved from `vehicle`.
callall_fastest_contact	object	Winning agent contact in CALL_ALL / HEAD_START modes.
vehicle	object	Echo of vehicle when supplied on create.
partner	object	`{"name": "…"}` partner account name.

Phone number rules

Digits only in international format — no +, spaces, or local 0 prefix
Supported country prefixes: 27 (ZA), 44 (UK), 91 (IN), 353 (IE)
Length: 9–15 digits (Ireland 353: 8–15 after country code)
All leg A and leg B numbers must share the same country dial code
Partner account must have the number's country enabled — error: {number} This number does not start with any of the call codes…

Lead reference safety checks

For connect_type: LEAD_CONNECT, when you send a non-empty reference, partner-configured guards may return 400:

Condition	Error message
Call already in progress	`A call is already in progress for this lead.`
Prior successful call	`This lead has already had a successful call with the prospect.`
Max retry limit	`The maximum retry limit of {N} attempts for this lead has been exceeded.`

Safety-net checks are skipped if reference is omitted. Contact Logimeter to configure which checks apply to your partner account.