CreateInvitationRequest class
Properties
-
emailAddress
↔ String
-
The email address the invitation will be sent to
getter/setter pair
-
expiresInDays
↔ int?
-
The number of days the invitation will be valid for. By default, the invitation expires after 30 days.
getter/setter pair
-
hashCode
→ int
-
The hash code for this object.
no setteroverride
-
ignoreExisting
↔ bool?
-
Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user.
getter/setter pair
-
notify
↔ bool?
-
Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to
true
.
getter/setter pair
-
publicMetadata
↔ Map<String, Object>
-
Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
getter/setter pair
-
redirectUrl
↔ String?
-
Optional URL which specifies where to redirect the user once they click the invitation link. This is only required if you have implemented a custom flow and you're not using Clerk Hosted Pages or Clerk Components.
getter/setter pair
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
templateSlug
↔ CreateInvitationRequestTemplateSlugEnum?
-
The slug of the email template to use for the invitation email.
getter/setter pair