OPopenintake
Referrals
Referrals

Decide Referral

Changed on

Staff decide what a referral held for them does, then it runs again (or is closed).

use_contact: the client is this contact on their phone. new_contact: the client is none of them. not_a_duplicate: a new case after all. add_to_case: it belongs on the possible duplicate, so it's added to that case instead (nothing on the case is overwritten). retry: run it again as it is. close: end it without sending anything. Every decision is kept.

post/referrals/{referral_id}/decide

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/referrals/{referral_id}/decide
  • Auth
    none declared

Path parameters

referral_idstring uuid required

Request body

action'use_contact' | 'new_contact' | 'not_a_duplicate' | 'add_to_case' | 'retry' | 'close' required
sa_contact_idinteger nullable

use_contact: one of the held referral's contact candidates

case_numberstring nullable

add_to_case: one of its possible duplicates

notestring nullable

Response

Successful Response

referral_idstring uuid required
first_namestring required
last_namestring required
emailstring nullable
phone_numberstring nullable
preferred_languagestring required
preferred_language_otherstring nullable
case_descriptionstring nullable
address_line1string nullable
address_line2string nullable
citystring nullable
statestring nullable
zip_codestring nullable
countystring nullable
date_of_birthstring date nullable
ssn_last4string nullable

Last four digits only; the full SSN is never returned

incident_datestring date nullable
statusstring required
needs_attention_reasonstring nullable
sa_contact_idinteger nullable
sa_case_idinteger nullable
sa_case_numberstring nullable
matched_existing_contactboolean required
was_dry_runboolean required
assuresign_statusstring required
partner_namestring required
partner_firm_namestring nullable
source'referral_portal' | 'intake_link'
submitted_atstring date-time required
processed_atstring date-time nullable
continues_case_numberstring nullable
sends_to_smartadvocateboolean nullable

Changes

  • 62d10ad76f8cRevision 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

  • 1e3d95fc77b0Revision changes
    • info

      added the optional property /// to the response with the status