Get Started

Set firm user API access

PATCH/api/v1/advisory-firms/{firm_id}/users/{user_id}/api-access

Enable or disable DayZero API access for a firm staff member. API access is enabled by default for everyone; firm owners/admins can restrict it per user.

Operation ID: set_firm_user_api_access_api_v1_advisory_firms__firm_id__users__user_id__api_access_patch·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
user_idstringrequired

Request body

Schema: FirmUserApiAccessRequest

api_access_enabledbooleanrequired

Whether the user may use the DayZero API.

Responses

200Successful Response

Schema: FirmUserApiAccessResponse

user_idstringrequired
api_access_enabledbooleanrequired

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

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