HIhint
Prospect

Create Prospect

Changed on
post/provider/prospects

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/prospects
  • Auth
    API key in header AUTHORIZATION

Request body

first_namestring
last_namestring
emailstring

Email address. Normalized (downcased, trimmed) and matched against existing contacts in the practice. If the email already exists, the prospect inherits its marketing authorization (e.g., an existing opt-out applies). Authorization is read-only on prospects — manage it via Set Communication Authorization.

phonestring

Mobile phone number.

statusstring

Prospect status (new, contacted, qualified, disqualified). Defaults to new. converted cannot be set directly - it is assigned when the prospect is converted into a patient.

dobstring date

Date must be formatted as YYYY-MM-DD.

address_line1string
address_line2string
address_citystring
address_statestring
address_zipstring
address_countrystring

Response

Successful response

idstring
address_citystring
address_countrystring
address_line1string
address_line2string
address_statestring
address_zipstring
created_atstring date-time
dobstring date
emailstring
email_marketing_authorization'opted_in' | 'opted_out'

Marketing consent recorded for this record's email address: opted_in (explicit opt-in), opted_out (explicit opt-out), or null when none has been recorded. null is not an opt-out — marketing email is permitted unless opted_out. Set it with Set Communication Authorization; it is read-only here.

first_namestring
last_namestring
lead_source_otherstring
phonestring
statusstring
updated_atstring date-time

Changes