SMsmokeball
Invitations

Invite a person to join the firm

Changed on

Invites a person who has no login yet to the firm associated with the authenticated client; accepting the invitation creates their login. The invitation is recorded asynchronously, so the returned link answers 404 for a few seconds. Set sendEmail to false to deliver it yourself.

post/invitations

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/invitations
  • Auth
    API key in header x-api-key and API key in header Authorization

Request body

emailstring email required

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

sendEmailboolean

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

Example request

{
  "email": "jane.doe@example.com",
  "sendEmail": true
}

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes