Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 1.29 KB

CreateOrganizationInvitationRequest.md

File metadata and controls

28 lines (22 loc) · 1.29 KB
Raw

ClerkBackend::CreateOrganizationInvitationRequest

Properties

Name Type Description Notes
email_address String The email address of the new member that is going to be invited to the organization
inviter_user_id 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
public_metadata Object Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. [optional]
private_metadata Object Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. [optional]
redirect_url String Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email. [optional]

Example

require 'clerk-sdk-ruby-backend'

instance = ClerkBackend::CreateOrganizationInvitationRequest.new(
  email_address: null,
  inviter_user_id: null,
  role: null,
  public_metadata: null,
  private_metadata: null,
  redirect_url: null
)