Settings

Get Lead Settings

Changed on

Get lead notification settings for the customer.

Returns lead notification settings including dry run mode and email recipients. If no settings exist, returns defaults (dry_run=True, empty recipients).

get/settings/leads

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/settings/leads
  • Auth: none declared

Response

Successful Response

email_notifications_enabledboolean required

Whether automatic lead notification emails are enabled

dry_runboolean required

Whether lead notification emails require manual sending

notification_email_recipientsstring[]

List of email addresses to receive lead notification emails

sms_notifications_enabledboolean required

Whether automatic lead notification SMS are enabled

notification_sms_recipientsstring[]

List of phone numbers (E.164 format) to receive lead notification SMS

lead_scoring_contextstring nullable

Criteria for scoring leads as low, medium, or high value

lead_scoring_mode'low_medium_high' | 'custom_prompt'

Which lead scoring strategy to use

lead_scoring_custom_promptstring nullable

Free-text scoring instructions used when lead_scoring_mode is 'custom_prompt'

lead_scoring_custom_schemaobject nullable

JSON Schema (draft-7 object) describing the custom scoring output when lead_scoring_mode is 'custom_prompt'

test_notifications_enabledboolean required

Whether notifications are sent for test calls and chats

lead_source_enabledboolean required

Whether lead source extraction is enabled for calls and chats

lead_generation_contextstring nullable

General context to guide lead classification and extraction behavior

urgency_enabledboolean

Assess urgency for leads and inquiries from calls and chats

urgency_promptstring nullable

Custom urgency criteria; null uses the default

urgency_default_promptstring required

Built-in urgency criteria (read-only)

info_request_forces_leadboolean required

Whether sending an info request SMS during a call forces the call to be classified as a lead

lead_notification_template'default' | 'legal_pocket' | 'credit_hound'

Which SES email template variant to use for lead notifications

lead_value_label'lead_value' | 'lead_priority' | 'lead_score'

Which label to display for the lead score metric (app UI, emails, SMS)

Changes

  • a208ca0461deRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status