`createOrganizationInvitation()`

Creates an OrganizationInvitation for new users to join an organization.


function createOrganizationInvitation: (params: CreateOrganizationInvitationParams) => Promise<OrganizationInvitation>;

`CreateOrganizationInvitationParams`

Name	Type	Description
`organizationId`	`string`	The organization ID of the organization a user is being invited to.
`inviterUserId`	`string`	The user ID of the user creating the invitation.
`emailAddress`	`string`	The email address to send the invitation to.
`role`	`string`	The role to assign the invited user within the organization.
`redirectUrl?`	`string`	The URL users will land at once the organization invitation has been accepted.
`publicMetadata?`	`Record<string, unknown>`	Metadata saved on the invitation that is visible to both your Frontend and Backend APIs.

`createOrganizationInvitation()` example


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(opens in a new tab) for more details.

Last updated on January 12, 2024

CreateOrganizationInvitationParams

createOrganizationInvitation() example

Backend API (BAPI) endpoint

`CreateOrganizationInvitationParams`

`createOrganizationInvitation()` example