Sign in
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 required
firm_namestring nullable

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

emailstring email required
phone_numberstring nullable
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

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