createOrganizationInvitation()
Creates an OrganizationInvitation for new users to join an organization.
function createOrganizationInvitation: (params: CreateOrganizationInvitationParams) => Promise<OrganizationInvitation>;- Name
organizationId- Type
string- Description
The organization ID of the organization a user is being invited to.
- Name
inviterUserId- Type
string- Description
The user ID of the user creating the invitation.
- Name
emailAddress- Type
string- Description
The email address to send the invitation to.
- Name
role- Type
string- Description
The role to assign the invited user within the organization.
- Name
redirectUrl?- Type
string- Description
The URL users will land at once the organization invitation has been accepted.
- Name
publicMetadata?- Type
Record<string, unknown>- Description
Metadata saved on the invitation that is visible to both your Frontend and Backend APIs.
const organizationId = 'org_2ZUtbk2yvnFGItdeze1ivCh3uqh';
const inviterUserId = 'user_2V7JJKmoA9HqzHhfMqK5cpgLl56';
const emailAddress = 'testclerk123@clerk.dev';
const role = 'org:member';
const response = await clerkClient.organizations.createOrganizationInvitation({organizationId, inviterUserId, emailAddress, role});
console.log(response);
/*
_OrganizationInvitation {
id: 'orginv_2b6SO8VwBMDn2IMYn0xqiaSxVpN',
emailAddress: 'testclerk123@clerk.dev',
role: 'org:member',
organizationId: 'org_2ZUtbk2yvnFGItdeze1ivCh3uqh',
createdAt: 1705534000014,
updatedAt: 1705534000014,
status: 'pending',
publicMetadata: {},
privateMetadata: {}
}
*/Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint POST/organizations/{organization_id}/invitations. See the BAPI reference for more details.