Interface EjectGroupMemberOptions`Experimental`

Options for ejecting a Partner group member.

Partner API surface; shape may change as the Partner API docs evolve.

interface EjectGroupMemberOptions {
    email?: string | null;
    groupId: GroupId;
    memberAccountId: AccountId;
    signal?: AbortSignal;
}

Index

Properties

email? groupId memberAccountId signal?

Properties

`Optional` `Readonly` `Experimental`email

email?: string | null

Replacement email for the ejected account, or null to keep the current email address.

`Readonly` `Experimental`groupId

groupId: GroupId

Group ID that currently contains the member.

`Readonly` `Experimental`memberAccountId

memberAccountId: AccountId

Account ID of the group member being ejected.

`Optional` `Readonly` `Experimental`signal

signal?: AbortSignal

Abort signal for cancelling the request.