Lead Docket

Get Lead Docket Status

Changed on

Return Lead Docket integration state for the tile and dev page.

get/lead-docket/status

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/lead-docket/status
  • Auth: none declared

Response

Successful Response

feature_enabledboolean required

Whether lead_docket_enabled is on for this customer

endpoint_url_setboolean required

Whether an endpoint URL has been configured

endpoint_url_maskedstring nullable

Stored endpoint URL with query parameter values dotted out for safe display

connectedboolean required

True when feature is enabled, endpoint is set, and dry_run is off

dry_runboolean required

Whether pushes require manual approval

timeout_secondsinteger required

Per-request timeout in seconds

mapping_countinteger required

Number of configured field mappings

opportunity_sync_enabledboolean
opportunity_note_fieldstring nullable
questionnaire_fill_enabledboolean
questionnaire_requests_enabledboolean
intake_complete_email_enabledboolean
intake_complete_email_recipientsstring[]

Changes

  • 5d668a9fc9ddRevision 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 optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 28867c1dbb52Revision changes
    • info

      added the optional property to the response with the status