Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerk.com

createInvitation()

Creates a new invitation for the given email address and sends the invitation email.

If an email address has already been invited or already exists in your application, trying to create a new invitation will return an error. To bypass this error and create a new invitation anyways, set ignoreExisting to true.

const invitation = await clerkClient.invitations.createInvitation({ emailAddress: 'invite@example.com', redirectUrl: 'https://optionally-redirect-here', publicMetadata: { "example": "metadata", "example_nested": { "nested": "metadata", }, } });

CreateParams

NameTypeDescription
emailAddressstringThe email address of the user to invite.
redirectUrl?stringThe URL to redirect the user to after they accept the invitation.
publicMetadata?Record<string, unknown>Metadata saved on the invitation that is visible to both your Frontend and Backend APIs.
notify?booleanOptional flag to denote whether an email invitation should be sent to the given email address. Defaults to true.
ignoreExisting?booleanOptional flag to denote whether an invitation should be created if there is already an existing invitation for this email address, or if the email address already exists in the application. Defaults to false.

Last updated on January 31, 2024

What did you think of this content?

Clerk © 2024