Skip to main content
POST
Invite a person to join the firm

Authorizations

x-api-key
string
header
required
Authorization
string
header
required

Body

The person to invite.

An invitation to create.

email
string<email>
required

Email address of the person being invited to join the firm.

Minimum string length: 1
Example:

"jane.doe@example.com"

sendEmail
boolean

Whether the platform emails the invitation (default true); false to deliver it yourself.

Example:

true

Response

When the request is accepted. Returns a hypermedia 'Link' object of the invitation.

id
string | null
href
string | null
relation
string | null
method
string | null
default:GET