docs/classes/management.SDK.InvitationsClient.html
new InvitationsClient(options: BaseClientOptions): InvitationsClient
list(
id: string,
request?: ListOrganizationInvitationsRequestParameters,
requestOptions?: InvitationsClient.RequestOptions,
): Promise<
Page<
OrganizationInvitation,
ListOrganizationInvitationsOffsetPaginatedResponseContent,
>,
>
Retrieve a detailed list of invitations sent to users for a specific Organization. The list includes details such as inviter and invitee information, invitation URLs, and dates of creation and expiration. To learn more about Organization invitations, review Invite Organization Members.
Organization identifier.
OptionalrequestOptions: InvitationsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.invitations.list("id", { page: 1, per_page: 1, include_totals: true, fields: "fields", include_fields: true, sort: "sort" })Copy
create(
id: string,
request: CreateOrganizationInvitationRequestContent,
requestOptions?: InvitationsClient.RequestOptions,
): HttpResponsePromise<CreateOrganizationInvitationResponseContent>
Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization. To learn more about Organization invitations, review Invite Organization Members.
Organization identifier.
OptionalrequestOptions: InvitationsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.invitations.create("id", { inviter: { name: "name" }, invitee: { email: "email" }, client_id: "client_id" })Copy
get(
id: string,
invitation_id: string,
request?: GetOrganizationInvitationRequestParameters,
requestOptions?: InvitationsClient.RequestOptions,
): HttpResponsePromise<GetOrganizationInvitationResponseContent>
Organization identifier.
The id of the user invitation.
OptionalrequestOptions: InvitationsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.invitations.get("id", "invitation_id", { fields: "fields", include_fields: true })Copy
delete(
id: string,
invitation_id: string,
requestOptions?: InvitationsClient.RequestOptions,
): HttpResponsePromise<void>
Organization identifier.
The id of the user invitation.
OptionalrequestOptions: InvitationsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.invitations.delete("id", "invitation_id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods listcreategetdelete Properties _options