Skip to main content

Function: createMemberInvite()

createMemberInvite(client, props): Promise<{ id: number; role: "ADMIN" | "MEMBER" | "VIEWER"; status: "PENDING" | "ACCEPTED" | "REJECTED"; createdAt: string; updatedAt?: string; invitedByUserId: number; inviteeUserId: number | null; inviteeEmail: string | null; memberId: number | null; orgId: number | null; projectId: number | null; orgName: string | null; projectName: string | null; userAccountEmail: string | null; userFullName: string | null; userName: string | null; userPersonalOrgId: number | null; }>

Creates a member invite for an organization or project.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

query​

{ orgName: string; projectName: string; } | { orgName: string; } = createMemberInviteQuerySchema

Query parameters (orgName, optional projectName)

body​

{ usernameOrEmail: string; role: "ADMIN" | "MEMBER" | "VIEWER"; } = createMemberInviteBodySchema

Request body with usernameOrEmail and role

body.usernameOrEmail​

string = ...

body.role​

"ADMIN" | "MEMBER" | "VIEWER" = ...

Returns​

Promise<{ id: number; role: "ADMIN" | "MEMBER" | "VIEWER"; status: "PENDING" | "ACCEPTED" | "REJECTED"; createdAt: string; updatedAt?: string; invitedByUserId: number; inviteeUserId: number | null; inviteeEmail: string | null; memberId: number | null; orgId: number | null; projectId: number | null; orgName: string | null; projectName: string | null; userAccountEmail: string | null; userFullName: string | null; userName: string | null; userPersonalOrgId: number | null; }>

Promise resolving to the created member invite

Operation Id​

create-member-invite