Invitations

Invite users into the child clients of your account, so they can sign in to the SQUAKE Dashboard.

The Invitations API invites users into the child clients of your account. SQUAKE emails each invited user a link to set a password and finish signing up, after which they can sign in to the SQUAKE Dashboard as a user of that client.

Invitations only work for child clients. To manage the users of your own organization, use the SQUAKE Dashboard.

How invitations work

  • Each invitation ties exactly one user to exactly one child client.
  • SQUAKE creates the user if they don't exist yet, or reuses the user if the email address already belongs to a user of that child client.
  • Inviting the same email address to the same child client again is safe. SQUAKE returns the existing invitation with an updated sent_at and sends the email again. The id and the invitation_url stay the same, so links in earlier emails keep working.
  • After a user accepts, accepted_at is set, and the user can't be invited to that client again.
  • The invitation email and the acceptance page are available in English, German and French.

Guides

TaskEndpointGuide
Invite a user, or send the invitation againPOST /v2/invitationsInvite a user
Check whether a user accepted, or get the link againGET /v2/invitations/{id}Retrieve an invitation

On this page