mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-06 04:19:25 +00:00
13 lines
5.9 KiB
Markdown
13 lines
5.9 KiB
Markdown
# RequestBody
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `emailAddress` | *String* | :heavy_check_mark: | The email address of the new member that is going to be invited to the organization |
|
|
| `inviterUserId` | *String* | :heavy_check_mark: | The ID of the user that invites the new member to the organization.<br/>Must be an administrator in the organization. |
|
|
| `role` | *String* | :heavy_check_mark: | The role of the new member in the organization. |
|
|
| `publicMetadata` | [Optional<? extends com.clerk.backend_api.models.operations.CreateOrganizationInvitationBulkPublicMetadata>](../../models/operations/CreateOrganizationInvitationBulkPublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. |
|
|
| `privateMetadata` | [Optional<? extends com.clerk.backend_api.models.operations.CreateOrganizationInvitationBulkPrivateMetadata>](../../models/operations/CreateOrganizationInvitationBulkPrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. |
|
|
| `redirectUrl` | *Optional<? extends String>* | :heavy_minus_sign: | Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email. | |