Lead Connection

A lead connection represents a pre-configured endpoint that accepts Leads in a certain format.

Attributes

Attribute	Type	Description
id	String	The unique id of the LeadConnection.
tenant_id	Integer	The id of the Tenant the LeadConnection belongs to.
company_id	Integer	The id of the Company the LeadConnection belongs to.
event_id	Integer	The id of the default Event that will be assigned to incoming Leads using this LeadConnection.
lead_source_id	Integer	The id of the default LeadSource that will be assigned to incoming Leads using this LeadConnection.
workflow_id	Integer	The id of the default Workflow that will be assigned to incoming Leads using this LeadConnection.
rep_primary_id	Integer	The id of the default User that will be assigned as the primary rep to incoming Leads using this LeadConnection.
site_type_id	Integer	The id of the default SiteType that will be assigned to incoming Leads using this LeadConnection.
is_active	Boolean	Whether the LeadConnection is active or not.
data_type	String	The data type or format the LeadConnection expects incoming Leads to be formatted in (json, excel, text).
name	String	The name of the LeadConnection.
description	String	A brief description of the LeadConnection.
last_lead_received_at	DateTime	The date time of when the LeadConnection last received a Lead.
created_at	DateTime	The date time of when the LeadConnection was created.
updated_at	DateTime	The date time of when the LeadConnection was last updated.

Allowed includes

Relation	Type	Description
company	Company	The Company the LeadConnection belongs to.
event	Event	The default Event that is assigned to Leads using this LeadConnection.
lead_source	LeadSource	The default LeadSource that is assigned to Leads using this LeadConnection.
workflow	Workflow	The default Workflow that is assigned to Leads using this LeadConnection.
rep_primary	User	The default User that is assigned as the primary rep to Leads using this LeadConnection.
site_type	SiteType	The default SiteType that is assigned to Leads using this LeadConnection.

Allowed filters

Name	Type	Description
id	Integer	Filter LeadConnections by their id.
company_id	Integer	Filter LeadConnections to a specific Company.
event_id	Integer	Filter LeadConnections to a specific Event.
lead_source_id	Integer	Filter LeadConnections to a specific LeadSource.
workflow_id	Integer	Filter LeadConnections to a specific Workflow.
rep_primary_id	Integer	Filter LeadConnections to a specific User.
site_type_id	Integer	Filter LeadConnections to a specific SiteType.
is_active	Boolean	Filter LeadConnections on whether they are active or not.
data_type	String	Filter LeadConnections to what data type they accept (json, excel, text).

Allowed sorts

Name	Description
name	Sort LeadConnections by their name.
is_active	Sort LeadConnections by whether they are active or not.
created_at	Sort LeadConnections by when they where created.
updated_at	Sort LeadConnections by when they where last updated.
last_lead_received_at	Sort LeadConnections by when they last received a Lead.