Skip to navigation
WhizBoard APIInvitations

Create Invitations

View as Markdown

Invite staff or clients to a firm.

Allowed roles:

  • owner

Required fields:

  • emails (array of email strings)
  • role (string) — one of ca_staff | client

Authentication

Authorizationstring
API Key authentication via header

Path parameters

firm_slugstringRequired3-64 characters

Request

This endpoint expects an object.
emailslist of stringsRequired
roleenumRequired

Role of a user within a Firm (tenant).

Allowed values:

Response

Successful Response
dataobject
statusstringOptionalDefaults to success

Errors

422
Unprocessable Entity Error