Start free trial

Invite a staff member to the firm

POST/api/v1/advisory-firms/{firm_id}/users/invite

Invite a user by email to join the firm as staff (admin or member). If the user already exists they are added immediately; otherwise an invitation email is sent and they are added on signup. Owner role cannot be assigned via invitation.

Operation ID: invite_staff_to_firm_api_v1_advisory_firms__firm_id__users_invite_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

firm_idstringrequired

Request body

Schema: InviteStaffRequest

emailstringrequired

Email address of the person to invite.

rolestring

Role to assign: 'admin' or 'member'. Owner cannot be invited.

One of: admin, member

first_namestring

Optional first name to personalize the invitation.

last_namestring

Optional last name to personalize the invitation.

messagestring

Optional personal message from the inviter included in the email.

business_idsarray · string

For 'member' role: explicit list of businesses the invitee should be assigned to on acceptance. Ignored for 'admin' (admins see every firm business).

team_idstring

For 'member' role: team to add the invitee to on acceptance. Mutually exclusive with 'business_ids' and 'assign_all_firm_businesses'.

assign_all_firm_businessesboolean

For 'member' role: if true, grant the invitee direct assignment to every currently active firm business on acceptance.

Responses

201Successful Response

Schema: SuccessEnvelope_InviteStaffResponse_

successboolean
messagestring
codestring
dataInviteStaffResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

409Conflict - Resource already exists

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject