Invite a client user to a business

POST/api/v1/advisory-firms/{firm_id}/businesses/{business_id}/invite-client

Invite a user by email to access a client business. If the user already exists they are added immediately; otherwise an invitation email is sent and they are added on signup.

Operation ID: invite_client_to_business_api_v1_advisory_firms__firm_id__businesses__business_id__invite_client_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
business_idstringrequired

Request body

Schema: InviteClientRequest

emailstringrequired: Email address of the client to invite.
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.

Responses

201Successful Response

Schema: SuccessEnvelope_InviteClientResponse_

successboolean
messagestring
codestring
dataInviteClientResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

409Conflict - Resource already exists

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/advisory-firms/{firm_id}/businesses/{business_id}/invite-client

bash

curl -X POST 'https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/businesses/{business_id}/invite-client' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "string"
}'