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.

List all entities

Get the list of all entities.

Responses
200

OK

get/entities
Request samples
curl -i -X GET \
  https://app.leadconduit.com/entities
Response samples
application/json
[
  • {
    • "id": "5fd439df60f288816f7ba2aa",
    • "account": true,
    • "deprecated": true,
    • "description": "string",
    • "field_suffix": "strin",
    • "flow_ids": [
      • "string"
      ],
    • "logo_url": "http://example.com",
    • "module_ids": [
      • "string"
      ],
    • "name": "string",
    • "recipient": "buyer",
    • "see": "string",
    • "source": "form",
    • "standard": true,
    • "time_zone": "string",
    • "trustedform_certified_vendor": true,
    • "website": "http://example.com",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
]

Create a new entities

Create a new entities

Request
Request Body schema: application/json

Create a new entity

deprecated
boolean
description
string
field_suffix
string or null [ 3 .. 5 ] characters ^[0-9a-zA-Z]+$
flow_ids
Array of strings or null (ID)
logo_url
string or null <uri>
module_ids
required
Array of strings or null (ModuleID)
name
required
string
recipient
required
string
Enum: "buyer" "crm" "analytics" "enhancement" "esp" "other" null
source
required
string
Enum: "form" "seller" "other" null
standard
boolean
time_zone
string or null
trustedform_certified_vendor
boolean
website
string or null <uri>
Responses
201

Created

post/entities
Request samples
application/json
{
  • "deprecated": true,
  • "description": "string",
  • "field_suffix": "strin",
  • "flow_ids": [
    • "string"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "name": "string",
  • "recipient": "buyer",
  • "source": "form",
  • "standard": true,
  • "time_zone": "string",
  • "trustedform_certified_vendor": true,
  • "website": "http://example.com"
}
Response samples
application/json
{
  • "id": "5fd439df60f288816f7ba2aa",
  • "account": true,
  • "deprecated": true,
  • "description": "string",
  • "field_suffix": "strin",
  • "flow_ids": [
    • "string"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "name": "string",
  • "recipient": "buyer",
  • "see": "string",
  • "source": "form",
  • "standard": true,
  • "time_zone": "string",
  • "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

Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the entity to get

Responses
200

OK

get/entities/{id}
Request samples
curl -i -X GET \
  https://app.leadconduit.com/entities/:id
Response samples
application/json
{
  • "id": "5fd439df60f288816f7ba2aa",
  • "account": true,
  • "deprecated": true,
  • "description": "string",
  • "field_suffix": "strin",
  • "flow_ids": [
    • "string"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "name": "string",
  • "recipient": "buyer",
  • "see": "string",
  • "source": "form",
  • "standard": true,
  • "time_zone": "string",
  • "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

Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the entity to update

Request Body schema: application/json

Create a new entity

deprecated
boolean
description
string
field_suffix
string or null [ 3 .. 5 ] characters ^[0-9a-zA-Z]+$
flow_ids
Array of strings or null (ID)
logo_url
string or null <uri>
module_ids
required
Array of strings or null (ModuleID)
name
required
string
recipient
required
string
Enum: "buyer" "crm" "analytics" "enhancement" "esp" "other" null
source
required
string
Enum: "form" "seller" "other" null
standard
boolean
time_zone
string or null
trustedform_certified_vendor
boolean
website
string or null <uri>
Responses
200

OK

put/entities/{id}
Request samples
application/json
{
  • "deprecated": true,
  • "description": "string",
  • "field_suffix": "strin",
  • "flow_ids": [
    • "string"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "name": "string",
  • "recipient": "buyer",
  • "source": "form",
  • "standard": true,
  • "time_zone": "string",
  • "trustedform_certified_vendor": true,
  • "website": "http://example.com"
}
Response samples
application/json
{
  • "id": "5fd439df60f288816f7ba2aa",
  • "account": true,
  • "deprecated": true,
  • "description": "string",
  • "field_suffix": "strin",
  • "flow_ids": [
    • "string"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "name": "string",
  • "recipient": "buyer",
  • "see": "string",
  • "source": "form",
  • "standard": true,
  • "time_zone": "string",
  • "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

Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the entity to delete

Responses
200

OK

delete/entities/{id}
Request samples
curl -i -X DELETE \
  https://app.leadconduit.com/entities/:id
Response samples
application/json
{
  • "id": "5fd439df60f288816f7ba2aa",
  • "account": true,
  • "deprecated": true,
  • "description": "string",
  • "field_suffix": "strin",
  • "flow_ids": [
    • "string"
    ],
  • "logo_url": "http://example.com",
  • "module_ids": [
    • "string"
    ],
  • "name": "string",
  • "recipient": "buyer",
  • "see": "string",
  • "source": "form",
  • "standard": true,
  • "time_zone": "string",
  • "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

Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the entity

Responses
200

OK

get/entities/{id}/changelogs
Request samples
curl -i -X GET \
  https://app.leadconduit.com/entities/:id/changelogs
Response samples
application/json
[
  • {
    • "id": "string",
    • "action": "create",
    • "changes": [
      • {
        • "action": "create",
        • "target": "string",
        • "delta_path": "string",
        • "previous": {
          • "value": "string"
          }
        }
      ],
    • "current_revision": {
      • "id": "5fd439df60f288816f7ba2aa",
      • "account": true,
      • "deprecated": true,
      • "description": "string",
      • "field_suffix": "strin",
      • "flow_ids": [
        • "string"
        ],
      • "logo_url": "http://example.com",
      • "module_ids": [
        • "string"
        ],
      • "name": "string",
      • "recipient": "buyer",
      • "see": "string",
      • "source": "form",
      • "standard": true,
      • "time_zone": "string",
      • "trustedform_certified_vendor": true,
      • "website": "http://example.com",
      • "created_at": "2019-08-24T14:15:22Z",
      • "updated_at": "2019-08-24T14:15:22Z"
      },
    • "delta_from_last_revision": {
      • "property1": [
        • "string"
        ],
      • "property2": [
        • "string"
        ]
      },
    • "type": "flow",
    • "user": {
      • "id": "string",
      • "first_name": "string",
      • "last_name": "string",
      • "email": "string"
      },
    • "created_at": "2020-11-23T11:41:52Z"
    }
]