SendInviteRequest

Invites someone by e-mail, either into the caller’s tenant or to register a tenant of their own.

Kind: an object, used in requests.

Fields

Field	Type	Required	Description
invitationCodeId	uuid	yes	The caller’s invitation code to spend one use of. Ignored when a tenant admin invites someone into their own tenant (inviteToTenant true): those invites use no code. Constraints: required (empty or whitespace-only strings are rejected).
emailAddress	string	yes	The e-mail address to send the invite to. Constraints: format: email, required (empty or whitespace-only strings are rejected).
inviteToTenant	boolean	yes	True to invite the person into the caller’s tenant (tenant admins only); false to invite them to register a new tenant. Constraints: required (empty or whitespace-only strings are rejected).
grantsAdmin	boolean | null		True: the invitee joins as a tenant admin (Tenant.Admin). Tenant admins only, and only with inviteToTenant true. Null or false: an ordinary member.

Example

{
  "invitationCodeId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "emailAddress": "...",
  "inviteToTenant": false,
  "grantsAdmin": false
}