Saltar al contenido principal
PATCH
Actualizar parcialmente lead
Scopes requeridos: leads.write

Autorizaciones

Authorization
string
header
requerido

Usa Authorization: Bearer rk_live_....

Encabezados

Idempotency-Key
string
requerido

Un valor único para cada solicitud nueva, como un UUID. Envíe el mismo valor para reintentar una solicitud de forma segura. La misma clave y el mismo payload repiten la primera respuesta con Idempotency-Replayed: true.

Required string length: 1 - 160

Parámetros de ruta

lead_id
string
requerido

Cuerpo

application/json
contact_name
string | null
Maximum string length: 200
contact_email
string<email> | null
contact_phone
string | null

Teléfono solo de EE. UU. Valores inválidos o no estadounidenses devuelven VALIDATION_ERROR.

property_address
string | null

Dirección de propiedad opcional. Se aceptan vacío, país EE. UU. explícito o formatos de estado + ZIP de EE. UU.; valores claramente no estadounidenses devuelven VALIDATION_ERROR.

Maximum string length: 500
form_data
object
custom_fields
object
selected_material_id
string | null
selected_color_id
string | null
selected_shape_id
string | null
status_stage_id
string
attribution
object
marketing_attribution_overrides
object
notes
string | null
Maximum string length: 5000
quote_value

Se acepta un número o una cadena numérica al escribir. Las respuestas serializadas usan número o null.

Rango requerido: 0 <= x <= 10000000
sales_value

Se acepta un número o una cadena numérica al escribir. Las respuestas serializadas usan número o null.

Rango requerido: 0 <= x <= 10000000
follow_up_date
string<date-time> | null

Fecha/hora ISO 8601 con Z o un desfase ±HH:MM. Se almacena en UTC.

lead_type
string

Clave o etiqueta actual de un tipo de lead del workspace. RoofKit guarda la clave. Si se omite, se conserva el valor actual, incluso si está vacío. Un valor enviado reemplaza el actual. Un valor desconocido devuelve VALIDATION_ERROR.

Required string length: 1 - 100

Respuesta

Lead actualizado.

lead
object
requerido
updated
boolean
requerido