Fields

A field represents a piece of data collected about a lead. When a field is referenced by ID from a flow's fields property, that piece of data will be captured when submitted. LeadConduit provides a large catalog of built-in fields, so there should rarely be a need to create a custom field. Custom fields are those where the standard property is false.

Free accounts do not have access to Fields (https://app.leadconduit.com/fields) and will receive a 401 (Unauthorized) error when trying to access it

Field

id
required
string

The required alphanumeric identifier of the field. Custom fields have an account-specific suffix (e.g. '_acme')

name
required
string

The human-readable name of the field

type
required
string

The data type of this field

Enum: Description
boolean

A boolean is a value that can be interpreted as true or false

city

The name of a city as part of an address

credential

A credential or other sensitive value. Credentials are not written to the database.

date

A date expressed as a year, month, and day

dob

A date of birth expressed as a year, month, and day

email

An email address

first_name

A first name value

gender

A value representing gender

last_name

A first name value

number

A numeric value

phone

A US telephone number

postal_code

The postal code portion of an address

range

A numeric range such as 1-10

ssn

A US Social Security Number. Not written to the database.

state

The state portion of an address

street

The street portion of an address

string

A generic string value

time

A date-time value

trustedform_url

The TrustedForm Certificate URL

url

A generic URL

description
string

The textual description of the purpose of this field

standard
boolean

Read-only flag indicating whether this is a built-in LeadConduit field

aggregate
boolean
deprecated
boolean

The flag indicating that this field should no longer be used

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

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

created_at
string <date-time> (Timestamp)

Read-only time the field was created

updated_at
string <date-time> (Timestamp)

Read-only time the field was last updated

{
  • "id": "first_name",
  • "name": "First Name",
  • "type": "boolean",
  • "description": "string",
  • "standard": true,
  • "aggregate": true,
  • "deprecated": true,
  • "see": "5fd4371e940df5a34a3888b2",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Type

Describes a LeadConduit field data type

name
required
string (TypeName)
Enum: "boolean" "city" "credential" "date" "email" "first_name" "gender" "last_name" "number" "phone" "postal_code" "range" "ssn" "state" "street" "string" "time" "trustedform_url" "url"
maskable
boolean

Are values of this type masked before they are persisted to the LeadConduit database?

required
Array of objects (TypeComponent) <= 0 items
operators
required
Array of strings
Items Enum: "is equal to" "is not equal to" "is blank" "is not blank" "is greater than" "is greater than or equal to" "is less than" "is less than or equal to" "is true" "is not true" "is false" "is not false" "format is valid" "format is invalid" "includes" "does not include" "is included in" "is not included in" "is between" "is not between" "matches pattern" "does not match pattern"
{
  • "name": "boolean",
  • "maskable": true,
  • "components": [ ],
  • "operators": [
    • "is equal to"
    ]
}

List all fields

Get the list of all fields, including all standard and custom fields.

SecurityAPIKey
Responses
200

OK

401

Authorization information is missing or invalid.

get/fields
Request samples 
Response samples 
application/json
[
  • {
    • "id": "first_name",
    • "name": "First Name",
    • "type": "boolean",
    • "description": "string",
    • "standard": true,
    • "aggregate": true,
    • "deprecated": true,
    • "see": "5fd4371e940df5a34a3888b2",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"
    }
]
Create a field
Create a new custom field, adding it to the list of all fields in the
account.


SecurityAPIKey 
Request 
Request Body schema: application/json
required
Create a new field


id
required
string
The required alphanumeric identifier of the field. Custom fields have an account-specific suffix (e.g. '_acme')


 
name
required
string
The human-readable name of the field


 
type
required
string
The data type of this field


 Enum: Description
boolean
A boolean is a value that can be interpreted as true or false


city
The name of a city as part of an address


credential
A credential or other sensitive value. Credentials are not written to the database.


date
A date expressed as a year, month, and day


dob
A date of birth expressed as a year, month, and day


email
An email address


first_name
A first name value


gender
A value representing gender


last_name
A first name value


number
A numeric value


phone
A US telephone number


postal_code
The postal code portion of an address


range
A numeric range such as 1-10


ssn
A US Social Security Number. Not written to the database.


state
The state portion of an address


street
The street portion of an address


string
A generic string value


time
A date-time value


trustedform_url
The TrustedForm Certificate URL


url
A generic URL


 
description
string
The textual description of the purpose of this field


 
standard
boolean
Read-only flag indicating whether this is a built-in LeadConduit field


 
aggregate
boolean
 
deprecated
boolean
The flag indicating that this field should no longer be used


 
created_at
string <date-time>  (Timestamp) 
Read-only time the field was created


 
updated_at
string <date-time>  (Timestamp) 
Read-only time the field was last updated


 
Responses 
201
Created


401
Authorization information is missing or invalid.


post/fields
Request samples 
application/json
{
  • "id": "first_name",
  • "name": "First Name",
  • "type": "boolean",
  • "description": "string",
  • "standard": true,
  • "aggregate": true,
  • "deprecated": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Response samples 
application/json
{
  • "id": "first_name",
  • "name": "First Name",
  • "type": "boolean",
  • "description": "string",
  • "standard": true,
  • "aggregate": true,
  • "deprecated": true,
  • "see": "5fd4371e940df5a34a3888b2",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Get a field
Fetch a single field.


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
ID of the field to get


 
 Example:  5fd4371e940df5a34a3888b2
Responses 
200
OK


401
Authorization information is missing or invalid.


get/fields/{id}
Request samples 
Response samples 
application/json
{
  • "id": "first_name",
  • "name": "First Name",
  • "type": "boolean",
  • "description": "string",
  • "standard": true,
  • "aggregate": true,
  • "deprecated": true,
  • "see": "5fd4371e940df5a34a3888b2",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Update a field
Update an existing custom field. Standard fields cannot be updated.


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
ID of the field to update


 
 Example:  5fd4371e940df5a34a3888b2
Request Body schema: application/json
required
Updated an existing field


id
required
string
The required alphanumeric identifier of the field. Custom fields have an account-specific suffix (e.g. '_acme')


 
name
required
string
The human-readable name of the field


 
type
required
string
The data type of this field


 Enum: Description
boolean
A boolean is a value that can be interpreted as true or false


city
The name of a city as part of an address


credential
A credential or other sensitive value. Credentials are not written to the database.


date
A date expressed as a year, month, and day


dob
A date of birth expressed as a year, month, and day


email
An email address


first_name
A first name value


gender
A value representing gender


last_name
A first name value


number
A numeric value


phone
A US telephone number


postal_code
The postal code portion of an address


range
A numeric range such as 1-10


ssn
A US Social Security Number. Not written to the database.


state
The state portion of an address


street
The street portion of an address


string
A generic string value


time
A date-time value


trustedform_url
The TrustedForm Certificate URL


url
A generic URL


 
description
string
The textual description of the purpose of this field


 
standard
boolean
Read-only flag indicating whether this is a built-in LeadConduit field


 
aggregate
boolean
 
deprecated
boolean
The flag indicating that this field should no longer be used


 
created_at
string <date-time>  (Timestamp) 
Read-only time the field was created


 
updated_at
string <date-time>  (Timestamp) 
Read-only time the field was last updated


 
Responses 
200
OK


401
Authorization information is missing or invalid.


put/fields/{id}
Request samples 
application/json
{
  • "id": "first_name",
  • "name": "First Name",
  • "type": "boolean",
  • "description": "string",
  • "standard": true,
  • "aggregate": true,
  • "deprecated": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Response samples 
application/json
{
  • "id": "first_name",
  • "name": "First Name",
  • "type": "boolean",
  • "description": "string",
  • "standard": true,
  • "aggregate": true,
  • "deprecated": true,
  • "see": "5fd4371e940df5a34a3888b2",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Delete a field
Delete an existing custom field. If a field is referenced in a flow and
is deleted, an HTTP 202 will be returned but that flow will continue to
operate as though the field still exists. The errors for each flow will
be returned to the response body and the recorded on the flow's error
property. More changes to the flow must dereference the field.


Standard fields cannot be deleted.


SecurityAPIKey 
Request 
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$
ID of the field to delete


 
 Example:  5fd4371e940df5a34a3888b2
Responses 
202
OK


401
Authorization information is missing or invalid.


delete/fields/{id}
Request samples 
Response samples 
application/json
{
  • "id": "first_name",
  • "name": "First Name",
  • "type": "boolean",
  • "description": "string",
  • "standard": true,
  • "aggregate": true,
  • "deprecated": true,
  • "see": "5fd4371e940df5a34a3888b2",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}
List changes to a Field
Lists all the changes made to a Field


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


 
 Example:  5fd4371e940df5a34a3888b2
Responses 
200
OK


get/fields/{id}/changelogs
Request samples 
Response samples 
application/json
null
List data types
Lists the data types available for fields or vars


SecurityAPIKey 
Responses 
200
OK


get/types
Request samples 
Response samples 
application/json
[
  • {
    • "name": "boolean",
    • "maskable": true,
    • "components": [ ],
    • "operators": [
      • "is equal to"
      ]
    }
]
List variables
The /vars resource is used to identify which data points have been
collected in your flows. This resource is used to determine which data
points are available for exports and stats queries.


As a lead is processed by a flow, a variable for every field value and
every piece of appended data is created. If the variable for a data point
already exists, a new one is not created. That is to say that there will
only ever be one lead.email variable. Each time an email address is
collected, the last_seen_at timestamp is updated.


SecurityAPIKey 
Request 
query Parameters
flow_id
string (ID) ^[0-9a-fA-F]{24}$
Return only variables where the flow ID matches this value (multiple
flow_id parameters may be used to select variables across several
specific flows)


 
 Example:  flow_id=5fd4371e940df5a34a3888b2
start
string <date-time>  (Timestamp) 
Return only variables seen at or after this time


 
end
string <date-time>  (Timestamp) 
Return only variables created at or before this time


 
exclude
Array of strings
 
Responses 
200
OK


get/vars
Request samples 
Response samples 
application/json
[
  • {
    • "name": "string",
    • "last_used_at": "2019-08-24T14:15:22Z",
    • "first_used_at": "2019-08-24T14:15:22Z",
    • "type": "string",
    • "description": "string",
    • "label": "string",
    • "module_id": "string",
    • "entity_id": "5fd4371e940df5a34a3888b2",
    • "examples": [
      • "string"
      ]
    }
]