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_id string required
business_id string required

Request body

Schema: InviteClientRequest

email string required: Email address of the client to invite.
first_name string: Optional first name to personalize the invitation.
last_name string: Optional last name to personalize the invitation.
message string: Optional personal message from the inviter included in the email.

Responses

201 Successful Response

Schema: InviteClientResponse

status string required: 'added' if user existed and was added, 'invited' if invitation email was sent.
reason string: Why this branch was chosen. Lets the UI render the right confirmation message without parsing 'message'.
message string required
email_sent boolean: Whether the notification email was sent successfully.

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

409 Conflict - Resource already exists

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

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"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/businesses/{business_id}/invite-client', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "email": "string"
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "email": "string"
}

response = httpx.post("https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/businesses/{business_id}/invite-client", headers=headers, json=payload)
data = response.json()