Entities

An entity is used to track lead flow. Each entity can be a source or a recipient or both. Entities can be used in multiple flows. When an entity is a source, it can be added to a flow as a source and when it is a recipient, it can be added to a flow as a recipient.

Entity

id	string (ID) ^[0-9a-fA-F]{24}$ 24 character alpha-numeric BSON identifier
name required	string The name of the entity which is displayed throughout LeadConduit's UI
description	string
standard	boolean Read-only flag indicating whether this is a built-in entity
	boolean or null Read-only flag indicating whether this entity represents another LeadConduit account holder
pending	boolean Read-only flag indicating whether this entity represents a pending entity waiting for invitation acceptance
connected	string Read-only flag if this Account entity is connected to my account Enum: "seller" "buyer" "both"
deprecated	boolean
see	string (ID) ^[0-9a-fA-F]{24}$ The alternative entity ID to be used instead of this deprecated entity
	string or null The suffix required for all custom fields
	ID (string) or null The ID of the invitation ID created on Accounts side to reference the entity
flow_ids	Array of strings (ID) Array of flow IDs where this entity is listed in the `sources` array (or `null` if the `account` property is `false`
	string or null <uri> The logo for this entity
module_ids required	Array of strings (ModuleID) Array of integration module IDs that are supported by this entity
required	null or string Is this entity a lead source and if so, what kind?
required	null or string Is this entity a lead recipient and if so, what kind?
time_zone	string If this entity represents a buyer or seller with an account, this is the account's time zone
trustedform_certified_vendor	boolean If this entity represents a seller, is that company a TrustedForm Certified Vendor?
website	string <uri> If this entity represents a buyer or seller, this is the URL to their marketing site
created_at	string <date-time> The time this entity was created
updated_at	string <date-time> The time this entity was last modified

{"id": "5fd4371e940df5a34a3888b2",
"name": "A Corporation",
"description": "string",
"standard": false,
"account": true,
"pending": true,
"connected": true,
"deprecated": false,
"see": "5fd4371e940df5a34a3888b2",
"field_suffix": "acorp",
"invitation_id": "5fd4371e940df5a34a3888b2",
"flow_ids": ["5fd4371e940df5a34a3888b2"
],
"logo_url": "string",
"module_ids": ["string"
],
"source": { },
"recipient": { },
"time_zone": "America/Los Angeles",
"trustedform_certified_vendor": true,
"website": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

List all entities

Get the list of all entities.

SecurityAPIKey

Responses

200

get/entities

Request samples

curl
Node.js
Ruby

Response samples

application/json

[ ]

Create a new entities

SecurityAPIKey

Request

Request Body schema: application/json
required

Create a new entity

name required	string The name of the entity which is displayed throughout LeadConduit's UI
description	string
deprecated	boolean
	string or null The suffix required for all custom fields
	ID (string) or null The ID of the invitation ID created on Accounts side to reference the entity
flow_ids	Array of strings (ID) Array of flow IDs where this entity is listed in the `sources` array (or `null` if the `account` property is `false`
	string or null <uri> The logo for this entity
module_ids required	Array of strings (ModuleID) Array of integration module IDs that are supported by this entity
required	null or string Is this entity a lead source and if so, what kind?
required	null or string Is this entity a lead recipient and if so, what kind?
time_zone	string If this entity represents a buyer or seller with an account, this is the account's time zone
trustedform_certified_vendor	boolean If this entity represents a seller, is that company a TrustedForm Certified Vendor?
website	string <uri> If this entity represents a buyer or seller, this is the URL to their marketing site

Responses

201

Created

post/entities

Request samples

Payload
curl
Node.js
Ruby

application/json

{"name": "A Corporation",
"description": "string",
"deprecated": false,
"field_suffix": "acorp",
"flow_ids": ["5fd4371e940df5a34a3888b2"
],
"logo_url": "string",
"module_ids": ["string"
],
"source": { },
"recipient": { },
"time_zone": "America/Los Angeles",
"trustedform_certified_vendor": true,
"website": "http://example.com"
}

Response samples

application/json

{"id": "5fd4371e940df5a34a3888b2",
"name": "A Corporation",
"description": "string",
"standard": false,
"account": true,
"pending": true,
"connected": true,
"deprecated": false,
"see": "5fd4371e940df5a34a3888b2",
"field_suffix": "acorp",
"invitation_id": "5fd4371e940df5a34a3888b2",
"flow_ids": ["5fd4371e940df5a34a3888b2"
],
"logo_url": "string",
"module_ids": ["string"
],
"source": { },
"recipient": { },
"time_zone": "America/Los Angeles",
"trustedform_certified_vendor": true,
"website": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get a entity

Returns the entity matching the specified ID

SecurityAPIKey

Request

path Parameters

required

string (ID) ^[0-9a-fA-F]{24}$

ID of the entity to get

Example: 5fd4371e940df5a34a3888b2

Responses

200

get/entities/{id}

Request samples

curl
Node.js
Ruby

Response samples

application/json

{"id": "5fd4371e940df5a34a3888b2",
"name": "A Corporation",
"description": "string",
"standard": false,
"account": true,
"pending": true,
"connected": true,
"deprecated": false,
"see": "5fd4371e940df5a34a3888b2",
"field_suffix": "acorp",
"invitation_id": "5fd4371e940df5a34a3888b2",
"flow_ids": ["5fd4371e940df5a34a3888b2"
],
"logo_url": "string",
"module_ids": ["string"
],
"source": { },
"recipient": { },
"time_zone": "America/Los Angeles",
"trustedform_certified_vendor": true,
"website": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update a entity

Update an existing entity matching the specified ID

SecurityAPIKey

Request

path Parameters

required

string (ID) ^[0-9a-fA-F]{24}$

ID of the entity to update

Example: 5fd4371e940df5a34a3888b2

Request Body schema: application/json
required

Create a new entity

name required	string The name of the entity which is displayed throughout LeadConduit's UI
description	string
deprecated	boolean
	string or null The suffix required for all custom fields
	ID (string) or null The ID of the invitation ID created on Accounts side to reference the entity
flow_ids	Array of strings (ID) Array of flow IDs where this entity is listed in the `sources` array (or `null` if the `account` property is `false`
	string or null <uri> The logo for this entity
module_ids required	Array of strings (ModuleID) Array of integration module IDs that are supported by this entity
required	null or string Is this entity a lead source and if so, what kind?
required	null or string Is this entity a lead recipient and if so, what kind?
time_zone	string If this entity represents a buyer or seller with an account, this is the account's time zone
trustedform_certified_vendor	boolean If this entity represents a seller, is that company a TrustedForm Certified Vendor?
website	string <uri> If this entity represents a buyer or seller, this is the URL to their marketing site

Responses

200

put/entities/{id}

Request samples

Payload
curl
Node.js
Ruby

application/json

{"name": "A Corporation",
"description": "string",
"deprecated": false,
"field_suffix": "acorp",
"flow_ids": ["5fd4371e940df5a34a3888b2"
],
"logo_url": "string",
"module_ids": ["string"
],
"source": { },
"recipient": { },
"time_zone": "America/Los Angeles",
"trustedform_certified_vendor": true,
"website": "http://example.com"
}

Response samples

application/json

{"id": "5fd4371e940df5a34a3888b2",
"name": "A Corporation",
"description": "string",
"standard": false,
"account": true,
"pending": true,
"connected": true,
"deprecated": false,
"see": "5fd4371e940df5a34a3888b2",
"field_suffix": "acorp",
"invitation_id": "5fd4371e940df5a34a3888b2",
"flow_ids": ["5fd4371e940df5a34a3888b2"
],
"logo_url": "string",
"module_ids": ["string"
],
"source": { },
"recipient": { },
"time_zone": "America/Los Angeles",
"trustedform_certified_vendor": true,
"website": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete a entity

Deletes the entity matching the specified ID

SecurityAPIKey

Request

path Parameters

required

string (ID) ^[0-9a-fA-F]{24}$

ID of the entity to delete

Example: 5fd4371e940df5a34a3888b2

Responses

200

delete/entities/{id}

Request samples

curl
Node.js
Ruby

Response samples

application/json

{"id": "5fd4371e940df5a34a3888b2",
"name": "A Corporation",
"description": "string",
"standard": false,
"account": true,
"pending": true,
"connected": true,
"deprecated": false,
"see": "5fd4371e940df5a34a3888b2",
"field_suffix": "acorp",
"invitation_id": "5fd4371e940df5a34a3888b2",
"flow_ids": ["5fd4371e940df5a34a3888b2"
],
"logo_url": "string",
"module_ids": ["string"
],
"source": { },
"recipient": { },
"time_zone": "America/Los Angeles",
"trustedform_certified_vendor": true,
"website": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

List changes to an Entity

List all the changes made to an entity

SecurityAPIKey

Request

path Parameters

required

string (ID) ^[0-9a-fA-F]{24}$

ID of the entity

Example: 5fd4371e940df5a34a3888b2

Responses

200

get/entities/{id}/changelogs

Request samples

curl
Node.js
Ruby

Response samples

application/json

null

Entities

Entity

List all entities

Create a new entities

Request Body schema: application/jsonrequired

Get a entity

path Parameters

Update a entity

path Parameters

Request Body schema: application/jsonrequired

Delete a entity

path Parameters

List changes to an Entity

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required