Skip to content

Latest commit

 

History

History
13 lines (10 loc) · 4.38 KB

RequestBody.md

File metadata and controls

13 lines (10 loc) · 4.38 KB

RequestBody

Fields

Field Type Required Description
emailAddress String ✔️ The email address of the new member that is going to be invited to the organization
inviterUserId JsonNullable<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<CreateOrganizationInvitationBulkPublicMetadata> Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API.
privateMetadata Optional<CreateOrganizationInvitationBulkPrivateMetadata> Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API.
redirectUrl Optional<String> Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email.