beamable-sdk / api / groupsDeleteMemberByObjectId
Function: groupsDeleteMemberByObjectId()¶
groupsDeleteMemberByObjectId(
requester,objectId,payload,gamertag?):Promise<HttpResponse<GroupMembershipResponse>>
Defined in: src/__generated__/apis/GroupsApi.ts:164
Parameters¶
requester¶
The HttpRequester type to use for the API request.
objectId¶
Gamertag of the player.Underlying objectId type is integer in format int64.
string | bigint
payload¶
The KickRequest instance to use for the API request
gamertag?¶
string
Override the Gamer Tag of the player. This is generally inferred by the auth token.
Returns¶
Promise<HttpResponse<GroupMembershipResponse>>
Remarks¶
Authentication:
This method requires a valid bearer token in the Authorization header.