| Field | Type | Required | Description |
|---|---|---|---|
emailAddress |
String | ✔️ | The email address of the new member that is going to be invited to the organization |
inviterUserId |
String | ✔️ | The ID of the user that invites the new member to the organization. Must be an administrator in the organization. |
role |
String | ✔️ | The role of the new member in the organization |
publicMetadata |
Optional<? extends com.clerk.backend_api.models.operations.CreateOrganizationInvitationPublicMetadata> | ➖ | 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.CreateOrganizationInvitationPrivateMetadata> | ➖ | 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> | ➖ | Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email. |