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.

List all fields

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

Responses
200

OK

401

Authorization information is missing or invalid.

get/fields
Request samples
curl -i -X GET \
  https://app.leadconduit.com/fields
Response samples
application/json
[
  • {
    • "id": "string",
    • "type": "string",
    • "name": "string",
    • "description": "string",
    • "standard": true,
    • "deprecated": true,
    • "see": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "examples": [
      • {
        • "name": "boolean",
        • "maskable": false,
        • "components": [ ],
        • "operators": [
          • "is true"
          ],
        • "examples": [
          • {
            • "normal": true,
            • "valid": true,
            • "raw": "yes"
            },
          • {
            • "normal": false,
            • "valid": true,
            • "raw": "no"
            },
          • {
            • "normal": true,
            • "valid": true,
            • "raw": "Y"
            },
          • {
            • "normal": false,
            • "valid": true,
            • "raw": "N"
            },
          • {
            • "normal": true,
            • "valid": true,
            • "raw": "true"
            },
          • {
            • "normal": false,
            • "valid": true,
            • "raw": "false"
            },
          • {
            • "normal": true,
            • "valid": true,
            • "raw": "T"
            },
          • {
            • "normal": false,
            • "valid": true,
            • "raw": "F"
            },
          • {
            • "normal": true,
            • "valid": true,
            • "raw": "1"
            },
          • {
            • "normal": false,
            • "valid": true,
            • "raw": "0"
            }
          ]
        }
      ]
    }
]

Create a field

Create a new custom field, adding it to the list of all fields in the account.

Request
Request Body schema: application/json

Create a new field

type
required
string

The required data type of this field

name
required
string

The required name of this flow that is displayed throughout LeadConduit's UI

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)
updated_at
required
string <date-time> (Timestamp)
Array of BooleanType (object) or CityType (object) or CredentialType (object) or DateType (object) or EmailType (object) or FirstNameType (object) or GenderType (object) or LastNameType (object) or NumberType (object) or PhoneType (object) or PostalCodeType (object) or RangeType (object) or SSNType (object) or StateType (object) or StreetType (object) or StringType (object) or TimeType (object) or TrustedFormURLType (object) or URLType (object) (Type)
Responses
201

Created

401

Authorization information is missing or invalid.

post/fields
Request samples
application/json
{
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "standard": true,
  • "deprecated": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "examples": [
    • {
      • "name": "boolean",
      • "maskable": false,
      • "components": [ ],
      • "operators": [
        • "is true"
        ],
      • "examples": [
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "yes"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "no"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "Y"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "N"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "true"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "false"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "T"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "F"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "1"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "0"
          }
        ]
      }
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "standard": true,
  • "deprecated": true,
  • "see": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "examples": [
    • {
      • "name": "boolean",
      • "maskable": false,
      • "components": [ ],
      • "operators": [
        • "is true"
        ],
      • "examples": [
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "yes"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "no"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "Y"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "N"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "true"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "false"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "T"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "F"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "1"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "0"
          }
        ]
      }
    ]
}

Get a field

Fetch a single field.

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

ID of the field to get

Responses
200

OK

401

Authorization information is missing or invalid.

get/fields/{id}
Request samples
curl -i -X GET \
  https://app.leadconduit.com/fields/:id
Response samples
application/json
{
  • "id": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "standard": true,
  • "deprecated": true,
  • "see": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "examples": [
    • {
      • "name": "boolean",
      • "maskable": false,
      • "components": [ ],
      • "operators": [
        • "is true"
        ],
      • "examples": [
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "yes"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "no"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "Y"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "N"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "true"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "false"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "T"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "F"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "1"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "0"
          }
        ]
      }
    ]
}

Update a field

Update an existing custom field. Standard fields cannot be updated.

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

ID of the field to update

Request Body schema: application/json

Updated an existing field

type
required
string

The required data type of this field

name
required
string

The required name of this flow that is displayed throughout LeadConduit's UI

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)
updated_at
required
string <date-time> (Timestamp)
Array of BooleanType (object) or CityType (object) or CredentialType (object) or DateType (object) or EmailType (object) or FirstNameType (object) or GenderType (object) or LastNameType (object) or NumberType (object) or PhoneType (object) or PostalCodeType (object) or RangeType (object) or SSNType (object) or StateType (object) or StreetType (object) or StringType (object) or TimeType (object) or TrustedFormURLType (object) or URLType (object) (Type)
Responses
200

OK

401

Authorization information is missing or invalid.

put/fields/{id}
Request samples
application/json
{
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "standard": true,
  • "deprecated": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "examples": [
    • {
      • "name": "boolean",
      • "maskable": false,
      • "components": [ ],
      • "operators": [
        • "is true"
        ],
      • "examples": [
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "yes"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "no"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "Y"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "N"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "true"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "false"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "T"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "F"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "1"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "0"
          }
        ]
      }
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "standard": true,
  • "deprecated": true,
  • "see": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "examples": [
    • {
      • "name": "boolean",
      • "maskable": false,
      • "components": [ ],
      • "operators": [
        • "is true"
        ],
      • "examples": [
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "yes"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "no"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "Y"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "N"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "true"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "false"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "T"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "F"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "1"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "0"
          }
        ]
      }
    ]
}

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.

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

ID of the field to delete

Responses
202

OK

401

Authorization information is missing or invalid.

delete/fields/{id}
Request samples
curl -i -X DELETE \
  https://app.leadconduit.com/fields/:id
Response samples
application/json
{
  • "id": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "standard": true,
  • "deprecated": true,
  • "see": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "examples": [
    • {
      • "name": "boolean",
      • "maskable": false,
      • "components": [ ],
      • "operators": [
        • "is true"
        ],
      • "examples": [
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "yes"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "no"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "Y"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "N"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "true"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "false"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "T"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "F"
          },
        • {
          • "normal": true,
          • "valid": true,
          • "raw": "1"
          },
        • {
          • "normal": false,
          • "valid": true,
          • "raw": "0"
          }
        ]
      }
    ]
}

List changes to a Field

Lists all the changes made to a Field

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

ID of the Field

Responses
200

OK

get/fields/{id}/changelogs
Request samples
curl -i -X GET \
  https://app.leadconduit.com/fields/: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"
    }
]