SendInviteResponse

The invite just created, and whether its e-mail went out. A failed send doesn’t undo the invite: it can still be re-sent and accepted, so the request succeeds and emailSent is false.

Kind: an object, used in responses.

Fields

Every field is present in a response; empty ones are null.

Field	Type	Description
emailSent	boolean	False when the invite was stored but its e-mail could not be sent.
inviteUrl	string | null	The link that accepts the invite, so you can pass it on another way. Set only when the e-mail of an invite into the tenant could not be sent; null otherwise.
invitationCodeId	uuid	The id of the invitation code the invite was sent with.
emailAddress	string	The e-mail address the invite was sent to. Only that address can accept it.
inviteToTenant	boolean	Whether the invite joins the inviter’s tenant (true) or registers a new tenant (false).
status	InviteStatus	Whether the invite is still open, was cancelled or has been accepted.
grantsAdmin	boolean | null	True when the person who accepts the invite (POST /users/register) joins as a tenant admin (Tenant.Admin) rather than an ordinary member. Null or false: an ordinary member.
userCreatedById	uuid	The id of the user who created it. A call made with an API key is recorded as the key’s user.
tenantId	uuid	The id of the tenant it belongs to.
id	uuid	The unique id. Use it in by-id routes and wherever another object refers to this one.
dateCreated	datetime	When it was created, in UTC.
dateUpdated	datetime	When it was last changed, in UTC.

Example

{
  "emailSent": false,
  "inviteUrl": "...",
  "invitationCodeId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "emailAddress": "...",
  "inviteToTenant": false,
  "status": "Unused",
  "grantsAdmin": false,
  "userCreatedById": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "tenantId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "dateCreated": "2026-10-26T12:00:00.0000000Z",
  "dateUpdated": "2026-10-26T12:00:00.0000000Z"
}