{"openapi":"3.1.0","info":{"title":"POST /api/v1/advisory-firms/{firm_id}/businesses/{business_id}/invite-client","version":"1.0.0","description":"Invite a client user to a business"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/advisory-firms/{firm_id}/businesses/{business_id}/invite-client":{"post":{"tags":["advisory-firms"],"summary":"Invite a client user to a business","description":"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.","operationId":"invite_client_to_business_api_v1_advisory_firms__firm_id__businesses__business_id__invite_client_post","parameters":[{"name":"firm_id","in":"path","required":true,"schema":{"type":"string","title":"Firm Id"}},{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteClientRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteClientResponse"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"detail":"Invalid request parameters"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"409":{"description":"Conflict - Resource already exists","content":{"application/json":{"example":{"detail":"Resource already exists"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InviteClientRequest":{"properties":{"email":{"type":"string","title":"Email","description":"Email address of the client to invite."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Optional first name to personalize the invitation."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Optional last name to personalize the invitation."},"message":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Message","description":"Optional personal message from the inviter included in the email."}},"type":"object","required":["email"],"title":"InviteClientRequest","description":"Request schema for inviting a client user to a business.","example":{"email":"client@example.com"}},"InviteClientResponse":{"properties":{"status":{"type":"string","title":"Status","description":"'added' if user existed and was added, 'invited' if invitation email was sent."},"reason":{"anyOf":[{"type":"string","enum":["clerk_confirmed","new_user","needs_clerk_signup","clerk_unavailable"]},{"type":"null"}],"title":"Reason","description":"Why this branch was chosen. Lets the UI render the right confirmation message without parsing 'message'."},"message":{"type":"string","title":"Message"},"email_sent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Email Sent","description":"Whether the notification email was sent successfully."}},"type":"object","required":["status","message"],"title":"InviteClientResponse","description":"Response schema for a client invitation."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}