Raw schema
{
"type": "object",
"properties": {
"lead_type": {
"type": "string",
"enum": [
"appointment",
"chat",
"email",
"event",
"other",
"phone_call",
"text_message",
"transaction",
"web_form"
],
"description": "Lead type."
},
"profile_id": {
"description": "Profile to add the lead to (required with an Agency key, not with a Profile key).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"date_created": {
"description": "When the lead happened (UTC); default now.",
"type": "string"
},
"quotable": {
"type": "string",
"enum": [
"yes",
"no",
"pending",
"not_set"
]
},
"quote_value": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"sales_value": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"lead_source": {
"description": "Traffic source, e.g. google.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"lead_medium": {
"description": "Traffic medium, e.g. cpc.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"lead_campaign": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"lead_content": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"lead_keyword": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"email_address": {
"description": "Contact email address (stored on the lead; nothing is sent to it).",
"type": "string",
"minLength": 3,
"maxLength": 254
},
"phone_number": {
"description": "Contact phone, E.164.",
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"lead_url": {
"description": "URL where the lead occurred.",
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"landing_url": {
"description": "URL where the visitor arrived.",
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"form_name": {
"description": "Form name (web_form only).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"message": {
"description": "Message body (text_message only).",
"type": "string",
"minLength": 1,
"maxLength": 5000
},
"call_duration_seconds": {
"description": "Call length in seconds (phone_call only).",
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"answer_status": {
"description": "phone_call only.",
"type": "string",
"enum": [
"Answered",
"No Answer",
"Busy"
]
},
"caller_number": {
"description": "Caller number, E.164 (phone_call / text_message).",
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"tracking_number": {
"description": "Tracking number, E.164 (phone_call / text_message).",
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"destination_number": {
"description": "Destination number, E.164 (phone_call).",
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"additional_fields": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[^\\[\\]&=#%\\x00-\\x1f]+$"
},
"additionalProperties": {
"type": "string",
"maxLength": 2000
}
},
"custom_fields": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^[^\\[\\]&=#%\\x00-\\x1f]+$"
},
"additionalProperties": {
"type": "string",
"maxLength": 2000
}
}
},
"required": [
"lead_type"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}