| Field | Type | Required | Description |
|---|---|---|---|
EmailAddress |
string | ✔️ | The email address the invitation will be sent to |
PublicMetadata |
Dictionary<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. |
RedirectUrl |
string | ➖ | The URL where the user is redirected upon visiting the invitation link, where they can accept the invitation. Required if you have implemented a custom flow for handling application invitations. |
Notify |
bool | ➖ | Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to true. |
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. |
ExpiresInDays |
long | ➖ | The number of days the invitation will be valid for. By default, the invitation expires after 30 days. |
TemplateSlug |
CreateBulkInvitationsTemplateSlug | ➖ | The slug of the email template to use for the invitation email. |