The Backend Invitation
object
The Backend Invitation
object represents an invitation to join your application.
Properties
- Name
id
- Type
string
- Description
The unique identifier for the
Invitation
.
- Name
emailAddress
- Type
string
- Description
The email address that the invitation was sent to.
- Name
publicMetadata
- Type
UserPublicMetadata
- Description
Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
- Name
createdAt
- Type
number
- Description
The date when the
Invitation
was first created.
- Name
updatedAt
- Type
number
- Description
The date when the
Invitation
was last updated.
- Name
status
- Type
'pending' | 'accepted' | 'revoked'
- Description
The status of the
Invitation
.
- Name
revoked?
- Type
boolean
- Description
Whether the
Invitation
has been revoked.
Feedback
Last updated on