OPopenintake
Admin

Invite Staff User

Changed on

Invite a new staff user to the current customer. Creates a user and sends them an invite email with a sign-in link. Requires admin authentication.

post/admin/staff/invite

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/admin/staff/invite
  • Auth
    none declared

Request body

emailstring required
first_namestring required
last_namestring required
user_type'admin' | 'staff' | 'referral_partner'

Enum for user types.

NOTE: SQLEnum(UserType) persists the member NAME, so each name must equal its value or writes break.

admin/staff are internal firm users with dashboard access. referral_partner is an EXTERNAL user (an outside referrer: an individual, organization, or attorney who sends the firm cases) whose only surface is the branded referral portal — see get_portal_user in app.auth.dependencies; get_user deliberately rejects this type so no internal endpoint is reachable.

role_idstring uuid nullable
login_methodsstring[] nullable
passwordstring nullable
skip_invite_emailboolean

Response

Successful Response

idstring required
emailstring required
first_namestring required
last_namestring required
user_type'admin' | 'staff' | 'referral_partner' required

Enum for user types.

NOTE: SQLEnum(UserType) persists the member NAME, so each name must equal its value or writes break.

admin/staff are internal firm users with dashboard access. referral_partner is an EXTERNAL user (an outside referrer: an individual, organization, or attorney who sends the firm cases) whose only surface is the branded referral portal — see get_portal_user in app.auth.dependencies; get_user deliberately rejects this type so no internal endpoint is reachable.

messagestring required

Changes

  • 05472eabc78dRevision changes
    • info

      added the new optional request property

  • 0afcd7c31ce2Revision changes
    • warning

      added the new referral_partner enum value to the response property for the response status

    • info

      added the new referral_partner enum value to the request property