Required parameters
| Field | Type | Required | Description |
|---|---|---|---|
emailAddress |
string | ✔️ | The email address the invitation will be sent to |
publicMetadata |
array<string, mixed> | ➖ | 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 | ➖ | 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. |
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 |
?int | ➖ | The number of days the invitation will be valid for. By default, the invitation does not expire. |