OPopenintake
Referrals
Referrals

Update Referral Partner

Changed on
patch/referrals/partners/{referral_partner_id}

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/partners/{referral_partner_id}
  • Auth
    none declared

Path parameters

referral_partner_idstring uuid required

Request body

is_activeboolean nullable
sa_contact_idinteger nullable

The partner's SmartAdvocate contact id. 0 clears it.

sa_attorney_contact_idinteger nullable

Referring attorney contact under an attorney-kind source. 0 clears it.

referral_source_kind'attorney' | 'other' | 'paid' | 'none' nullable

Book the partner's contact as the case's referral source of this kind (attorney = Referring Law Firm, other = Other Referral, paid = Advertise); none = the partner is not the source

case_contact_rolestring nullable

Attach the partner's contact in this case role, e.g. "Intake Paralegal"

intake_performed_bystring nullable

The firm's label for who took the intake, e.g. "Tiffany Feng"

test_accountboolean nullable

Developers only: its referrals are always dry runs

Response

Successful Response

referral_partner_idstring uuid required
namestring required
firm_namestring nullable
emailstring nullable
phone_numberstring nullable
has_loginboolean required

Whether a portal login exists for this partner

login_kind'partner' | 'firm_user' nullable

partner = a portal-only account; firm_user = one of the firm's own users

sa_contact_idinteger nullable
sa_attorney_contact_idinteger nullable
referral_source_kind'attorney' | 'other' | 'paid' nullable
case_contact_rolestring nullable
intake_performed_bystring nullable
test_accountboolean

Its referrals never reach SmartAdvocate (always a dry run)

is_activeboolean required
referral_countinteger
created_atstring date-time required
set_password_linkstring nullable

Only returned when a developer invited with skip_invite_email; must be delivered to the partner out of band.

Changes

  • 62b223e8ec22Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 4ceb1e8613eeRevision changes
    • info

      added the optional property to the response with the status