Skip to navigation
WhizBoard APIFirms

Create Firm

View as Markdown

Create a new firm (tenant).

The authenticated user becomes the firm owner and a corresponding membership is created.

Required fields:

  • name (string)
  • slug (string) — lowercase letters/digits with hyphens (public URL id)

Response:

  • id (int)
  • name (string)
  • slug (string)
  • owner_user_id (int)

Errors:

  • 401: Missing/invalid token
  • 409: Firm slug already exists
  • 422: Validation error

Authentication

Authorizationstring
API Key authentication via header

Request

This endpoint expects an object.
namestringRequired1-120 characters
slugstringRequiredformat: "^[a-z0-9]+(?:-[a-z0-9]+)*$"3-64 characters

Response

Successful Response
dataobject
statusstringOptionalDefaults to success

Errors

422
Unprocessable Entity Error