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.
Get the list of all fields, including all standard and custom fields.
OK
Authorization information is missing or invalid.
curl -i -X GET \ https://app.leadconduit.com/fields
[- {
- "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 new custom field, adding it to the list of all fields in the account.
Create a new field
Created
Authorization information is missing or invalid.
{- "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"
}
]
}
]
}
{- "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"
}
]
}
]
}
curl -i -X GET \ https://app.leadconduit.com/fields/:id
{- "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 an existing custom field. Standard fields cannot be updated.
Updated an existing field
OK
Authorization information is missing or invalid.
{- "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"
}
]
}
]
}
{- "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 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.
curl -i -X DELETE \ https://app.leadconduit.com/fields/:id
{- "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"
}
]
}
]
}
curl -i -X GET \ https://app.leadconduit.com/fields/:id/changelogs
[- {
- "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"
], - "module_ids": [
- "string"
], - "name": "string",
- "recipient": "buyer",
- "see": "string",
- "source": "form",
- "standard": true,
- "time_zone": "string",
- "trustedform_certified_vendor": true,
- "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"
}
]