Interface EjectGroupMemberRequest`Experimental`

Request parameters for b2_eject_group_member.

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

interface EjectGroupMemberRequest {
    adminAccountId: AccountId;
    email?: string | null;
    groupId: GroupId;
    memberAccountId: AccountId;
}

Index

Properties

adminAccountId email? groupId memberAccountId

Properties

`Readonly` `Experimental`adminAccountId

adminAccountId: AccountId

Account ID of the group administrator authorized for the Partner API.

`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.