mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-07 12:27:45 +00:00
14 lines
7.8 KiB
Markdown
14 lines
7.8 KiB
Markdown
# CreateInvitationRequestBody
|
|
|
|
Required parameters
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `emailAddress` | *String* | :heavy_check_mark: | The email address the invitation will be sent to |
|
|
| `publicMetadata` | [Optional<? extends com.clerk.backend_api.models.operations.CreateInvitationPublicMetadata>](../../models/operations/CreateInvitationPublicMetadata.md) | :heavy_minus_sign: | Metadata that will be attached to the newly created invitation.<br/>The value of this property should be a well-formed JSON object.<br/>Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. |
|
|
| `redirectUrl` | *Optional<? extends String>* | :heavy_minus_sign: | Optional URL which specifies where to redirect the user once they click the invitation link.<br/>This is only required if you have implemented a [custom flow](https://clerk.com/docs/authentication/invitations#custom-flow) and you're not using Clerk Hosted Pages or Clerk Components. |
|
|
| `notify_` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | Optional flag which denotes whether an email invitation should be sent to the given email address.<br/>Defaults to true. |
|
|
| `ignoreExisting` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user. | |