Leads

Update Lead

Changed on

Update an existing lead.

All fields are optional. Only provided fields will be updated. Useful for manual override of qualification status or case assignment.

patch/leads/{lead_id}

Request

  • Base URL: https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.openintake.ai/leads/{lead_id}
  • Auth: none declared

Path parameters

lead_idstring uuid required

Request body

case_idstring uuid nullable

Case ID to associate with the lead

is_qualifiedboolean nullable

Override qualification status

qualification_summarystring nullable

Override qualification summary

first_namestring nullable

Update first name

last_namestring nullable

Update last name

phone_numberstring nullable

Update phone number

emailstring nullable

Update email

addressstring nullable

Update mailing address

inquiry_reasonstring nullable

Update reason for call

lead_sourcestring nullable

Update where they heard about the firm

lead_scorestring nullable

Override lead score (low, medium, high, unknown)

lead_score_reasoningstring nullable

Override reasoning for lead score

Response

Successful Response

lead_idstring uuid nullable
outbound_lead_idstring uuid nullable
customer_idstring uuid required
call_idstring uuid nullable
conversation_idstring uuid nullable
form_session_idstring uuid nullable
case_idstring uuid nullable
first_namestring nullable
last_namestring nullable
phone_numberstring nullable
emailstring nullable
addressstring nullable
client_statusstring required
is_qualifiedboolean
qualification_summarystring nullable
lead_scorestring nullable
lead_score_reasoningstring nullable
custom_score_outputobject nullable
inquiry_reasonstring nullable
is_urgentboolean nullable
urgency_reasoningstring nullable
matter_namestring nullable
subject_linestring nullable
lead_sourcestring nullable
notification_emails_sentboolean
notification_sms_sentboolean
skip_notificationsboolean
created_atstring date-time required
updated_atstring date-time nullable

Changes

  • d61063451a04Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • a208ca0461deRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status