Groups - Accept Group Invitation

Service:

Groups

API Version:

241122

Accepts an invitation to join a group

POST https://titleId.playfabapi.com/Group/AcceptGroupInvitation

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
Group	True	EntityKey	The identifier of the group
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity		EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.

Responses

Name	Type	Description
200 OK	EmptyResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
AcceptGroupInvitationRequest	Accepts an outstanding invitation to join the group if the invited entity is not blocked by the group. Only the invited entity or a parent in its chain (e.g. title) may accept the invitation on the invited entity's behalf. Nothing is returned in the case of success.
ApiErrorWrapper	The basic wrapper around every failed API response
EmptyResponse
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.

AcceptGroupInvitationRequest

Accepts an outstanding invitation to join the group if the invited entity is not blocked by the group. Only the invited entity or a parent in its chain (e.g. title) may accept the invitation on the invited entity's behalf. Nothing is returned in the case of success.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The optional entity to perform this action on. Defaults to the currently logged in entity.
Group	EntityKey	The identifier of the group

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EmptyResponse

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

Error Codes

Name	Code
EntityBlockedByGroup	1357
EntityIsAlreadyMember	1359
GroupInvitationNotFound	1361
RoleDoesNotExist	1358