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
id required | string^[0-9a-fA-F]{24}$ 24 character alpha-numeric BSON identifier | ||||||||||||||||||||||||||||||||||||||||||
type required | string The data type of this field
| ||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||
deprecated | boolean The flag indicating that this field should no longer be used | ||||||||||||||||||||||||||||||||||||||||||
see | string^[0-9a-fA-F]{24}$ 24 character alpha-numeric BSON identifier | ||||||||||||||||||||||||||||||||||||||||||
created_at required | string <date-time> (Timestamp) Read-only time the field was created | ||||||||||||||||||||||||||||||||||||||||||
updated_at required | string <date-time> (Timestamp) Read-only time the field was last updated |
{- "id": "first_name",
- "type": "boolean",
- "description": "string",
- "standard": true,
- "deprecated": true,
- "see": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Describes a LeadConduit field data type
name | string 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? |
components | Array of strings <= 0 items |
operators | 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"
]
}
Get the list of all fields, including all standard and custom fields.
OK
Authorization information is missing or invalid.
[- {
- "id": "first_name",
- "type": "boolean",
- "description": "string",
- "standard": true,
- "deprecated": true,
- "see": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
Create a new custom field, adding it to the list of all fields in the account.
Create a new field
type required | string The data type of this field
| ||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||
deprecated | boolean The flag indicating that this field should no longer be used | ||||||||||||||||||||||||||||||||||||||||||
created_at required | string <date-time> (Timestamp) Read-only time the field was created | ||||||||||||||||||||||||||||||||||||||||||
updated_at required | string <date-time> (Timestamp) Read-only time the field was last updated |
Created
Authorization information is missing or invalid.
{- "type": "boolean",
- "description": "string",
- "standard": true,
- "deprecated": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
{- "id": "first_name",
- "type": "boolean",
- "description": "string",
- "standard": true,
- "deprecated": true,
- "see": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Fetch a single field.
OK
Authorization information is missing or invalid.
{- "id": "first_name",
- "type": "boolean",
- "description": "string",
- "standard": true,
- "deprecated": true,
- "see": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
Update an existing custom field. Standard fields cannot be updated.
Updated an existing field
type required | string The data type of this field
| ||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||
deprecated | boolean The flag indicating that this field should no longer be used | ||||||||||||||||||||||||||||||||||||||||||
created_at required | string <date-time> (Timestamp) Read-only time the field was created | ||||||||||||||||||||||||||||||||||||||||||
updated_at required | string <date-time> (Timestamp) Read-only time the field was last updated |
OK
Authorization information is missing or invalid.
{- "type": "boolean",
- "description": "string",
- "standard": true,
- "deprecated": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
{- "id": "first_name",
- "type": "boolean",
- "description": "string",
- "standard": true,
- "deprecated": true,
- "see": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
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.
OK
Authorization information is missing or invalid.
{- "id": "first_name",
- "type": "boolean",
- "description": "string",
- "standard": true,
- "deprecated": true,
- "see": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
[- {
- "id": "string",
- "action": "create",
- "changes": [
- {
- "action": "create",
- "target": "string",
- "delta_path": "string",
- "previous": {
- "value": "string"
}
}
], - "current_revision": { },
- "delta_from_last_revision": { },
- "type": "flow",
- "user": {
- "id": "string",
- "api_key": "2f1d5f29915b866c7a2fa5de29613104",
- "first_name": "string",
- "last_name": "string",
- "email": "string"
}, - "created_at": "2020-11-23T11:41:52Z"
}
]
[- {
- "name": "boolean",
- "maskable": true,
- "components": [ ],
- "operators": [
- "is equal to"
]
}
]
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.
OK
[- {
- "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": "string",
- "examples": [
- "string"
]
}
]