Tenants

Generate a tenant invitation token (admin)

Creates an invitation token that the admin shares with the invitee, who then uses it via POST /api/v1/tenants/me/invitations/accept or the signup flow /signup?invitation_token={token}. At most 5 active invitations per admin, and only while the plan has a seat left (409 otherwise).

post/api/v1/tenants/me/invitations

Request

  • Base URL: https://api.hub-equity.com
  • URL: https://api.hub-equity.com/api/v1/tenants/me/invitations
  • Auth: HTTP bearer

Request body

role'admin' | 'member'

Role given to the invitee when the token is accepted.

expires_in_daysinteger

Token validity in days. Default 7.

Response

Invitation created

successboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.