Skip to main content

LeadDocumentCreate

A document attached to a lead (for example a CV or brief). Document-type prompts can reference it by its type so the bot can reason over its content.

lead_idLead Idrequired

ID of the lead this record relates to.

nameNamerequired

Human-readable document name.

typeTyperequired

Document type label; matched against a document prompt's document_type.

document objectrequired

The document content.

text_dataText Datarequired

The document's text content.

document_url object

Optional URL to the original document.

anyOf
string
LeadDocumentCreate
{
  "lead_id": 0,
  "name": "string",
  "type": "string",
  "document": {
    "text_data": "string"
  },
  "document_url": "string"
}