OPopenintake
Referrals
Referrals

Invite Referral Partner

Changed on

Invite an outside referrer (individual, organization, or attorney): create their portal login and partner record together, then email a link to set their password.

The login is created without a password and the invite carries a single-use PasswordResetToken, because /auth/forgot-password cannot bootstrap an account that has never had one.

post/referrals/partners

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

Request body

namestring nullable

Required unless existing_user_id is given

firm_namestring nullable

Optional internal grouping label (e.g. the firm or company several referrers share). Never shown to the referrer.

emailstring email nullable

Their login; required unless existing_user_id is given

phone_numberstring nullable
existing_user_idstring uuid nullable

One of the firm's own users to make a partner (no new account, no email)

passwordstring nullable

Set the new account's password now instead of emailing an invite

skip_invite_emailboolean

Developers only: create the partner without sending the invite email and return the set-password link in the response (local dev / demos).

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

  • 4ceb1e8613eeRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      the request property's minLength was decreased from 1 to 0

    • info

      added the optional property to the response with the status