Referral Portal
Referral Portal

Submit Portal Referral

Changed on

Submit a new referral; enqueues the SmartAdvocate push.

post/portal/referrals

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/portal/referrals
  • Auth
    none declared

Request body

first_namestring required
last_namestring required
emailstring required
phone_numberstring required
address_line1string required
address_line2string nullable
citystring required
statestring required
zip_codestring required
countystring nullable
date_of_birthstring date nullable
ssnstring nullable

Optional; stored encrypted, never returned

incident_datestring date required

Required: the date of loss, also how a duplicate case is spotted

preferred_languagestring
preferred_language_otherstring nullable
case_descriptionstring nullable
attachment_idsstring[]

Files uploaded with POST /portal/referrals/attachments

draft_idstring uuid nullable

The draft this referral was written in; deleted on submit

Response

Successful Response

referral_idstring uuid required
statusstring required
messagestring required

Changes

    • info

      added the new optional request property //

    • breaking

      the request property became required

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • info

      added the new optional request property

    • info

      added the new optional request property /