Skip to navigation
WhizBoard APIFirms

Update Firm

View as Markdown

Update firm profile details.

Allowed roles:

  • owner

Send as multipart/form-data. All fields are optional; omitted fields are left unchanged. Empty optional text fields clear the existing value.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

firm_slugstringRequired3-64 characters

Request

This endpoint expects a multipart form containing an optional file.
namestring or nullOptional
contact_emailstring or nullOptional
contact_phonestring or nullOptional
descriptionstring or nullOptional

Response

Successful Response
dataobject
statusstringOptionalDefaults to success

Errors

422
Unprocessable Entity Error