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

standard
boolean

Read-only flag indicating whether this is a built-in entity

account
boolean

Read-only flag indicating whether this entity represents another LeadConduit account holder

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

The alternative entity ID to be used instead of this deprecated entity

field_suffix
string or null [ 3 .. 5 ] characters ^[0-9a-zA-Z]+$

The suffix required for all custom fields

flow_ids
Array of strings or null (ID)

Array of flow IDs where this entity is listed in the sources array (or null if the account property is false

logo_url
string or null <uri>

The logo for this entity

module_ids
required
Array of strings or null (ModuleID)

Array of integration module IDs that are supported by this entity

source
required
string or null

Is this entity a lead source and if so, what kind?

Enum: "form" "seller" "other"
recipient
required
string or null

Is this entity a lead recipient and if so, what kind?

Enum: "buyer" "crm" "analytics" "enhancement" "esp" "other"
time_zone
string or null

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 or null <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",
  • "standard": false,
  • "account": true,
  • "deprecated": false,
  • "see": "5fd4371e940df5a34a3888b2",
  • "field_suffix": "acorp",
  • "flow_ids": [
    • "5fd4371e940df5a34a3888b2"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "source": "form",
  • "recipient": "buyer",
  • "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

OK

get/entities
Request samples
Response samples
application/json
[ ]

Create a new entities

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

deprecated
boolean
field_suffix
string or null [ 3 .. 5 ] characters ^[0-9a-zA-Z]+$

The suffix required for all custom fields

flow_ids
Array of strings or null (ID)

Array of flow IDs where this entity is listed in the sources array (or null if the account property is false

logo_url
string or null <uri>

The logo for this entity

module_ids
required
Array of strings or null (ModuleID)

Array of integration module IDs that are supported by this entity

source
required
string or null

Is this entity a lead source and if so, what kind?

Enum: "form" "seller" "other"
recipient
required
string or null

Is this entity a lead recipient and if so, what kind?

Enum: "buyer" "crm" "analytics" "enhancement" "esp" "other"
time_zone
string or null

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 or null <uri>

If this entity represents a buyer or seller, this is the URL to their marketing site

Responses
201

Created

post/entities
Request samples
application/json
{
  • "name": "A Corporation",
  • "deprecated": false,
  • "field_suffix": "acorp",
  • "flow_ids": [
    • "5fd4371e940df5a34a3888b2"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "source": "form",
  • "recipient": "buyer",
  • "time_zone": "America/Los Angeles",
  • "trustedform_certified_vendor": true,
  • "website": "http://example.com"
}
Response samples
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "A Corporation",
  • "standard": false,
  • "account": true,
  • "deprecated": false,
  • "see": "5fd4371e940df5a34a3888b2",
  • "field_suffix": "acorp",
  • "flow_ids": [
    • "5fd4371e940df5a34a3888b2"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "source": "form",
  • "recipient": "buyer",
  • "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
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the entity to get

Example: 5fd4371e940df5a34a3888b2
Responses
200

OK

get/entities/{id}
Request samples
Response samples
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "A Corporation",
  • "standard": false,
  • "account": true,
  • "deprecated": false,
  • "see": "5fd4371e940df5a34a3888b2",
  • "field_suffix": "acorp",
  • "flow_ids": [
    • "5fd4371e940df5a34a3888b2"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "source": "form",
  • "recipient": "buyer",
  • "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
id
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

deprecated
boolean
field_suffix
string or null [ 3 .. 5 ] characters ^[0-9a-zA-Z]+$

The suffix required for all custom fields

flow_ids
Array of strings or null (ID)

Array of flow IDs where this entity is listed in the sources array (or null if the account property is false

logo_url
string or null <uri>

The logo for this entity

module_ids
required
Array of strings or null (ModuleID)

Array of integration module IDs that are supported by this entity

source
required
string or null

Is this entity a lead source and if so, what kind?

Enum: "form" "seller" "other"
recipient
required
string or null

Is this entity a lead recipient and if so, what kind?

Enum: "buyer" "crm" "analytics" "enhancement" "esp" "other"
time_zone
string or null

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 or null <uri>

If this entity represents a buyer or seller, this is the URL to their marketing site

Responses
200

OK

put/entities/{id}
Request samples
application/json
{
  • "name": "A Corporation",
  • "deprecated": false,
  • "field_suffix": "acorp",
  • "flow_ids": [
    • "5fd4371e940df5a34a3888b2"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "source": "form",
  • "recipient": "buyer",
  • "time_zone": "America/Los Angeles",
  • "trustedform_certified_vendor": true,
  • "website": "http://example.com"
}
Response samples
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "A Corporation",
  • "standard": false,
  • "account": true,
  • "deprecated": false,
  • "see": "5fd4371e940df5a34a3888b2",
  • "field_suffix": "acorp",
  • "flow_ids": [
    • "5fd4371e940df5a34a3888b2"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "source": "form",
  • "recipient": "buyer",
  • "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
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the entity to delete

Example: 5fd4371e940df5a34a3888b2
Responses
200

OK

delete/entities/{id}
Request samples
Response samples
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "A Corporation",
  • "standard": false,
  • "account": true,
  • "deprecated": false,
  • "see": "5fd4371e940df5a34a3888b2",
  • "field_suffix": "acorp",
  • "flow_ids": [
    • "5fd4371e940df5a34a3888b2"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "source": "form",
  • "recipient": "buyer",
  • "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
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the entity

Example: 5fd4371e940df5a34a3888b2
Responses
200

OK

get/entities/{id}/changelogs
Request samples
Response samples
application/json
[
  • {
    • "id": "5fd4371e940df5a34a3888b2",
    • "action": "create",
    • "changes": [
      • {
        • "action": "create",
        • "target": "string",
        • "delta_path": "string",
        • "previous": {
          • "value": "string"
          }
        }
      ],
    • "current_revision": { },
    • "delta_from_last_revision": { },
    • "type": "flow",
    • "user": {
      • "id": "5fd4371e940df5a34a3888b2",
      • "api_key": "2f1d5f29915b866c7a2fa5de29613104",
      • "first_name": "string",
      • "last_name": "string",
      • "email": "string"
      },
    • "created_at": "2020-11-23T11:41:52Z"
    }
]