Groups - Apply To Group

Service:

Groups

API Version:

241122

Applies to join a group

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

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
AutoAcceptOutstandingInvite		boolean	Optional, default true. Automatically accept an outstanding invitation if one exists instead of creating an application
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	ApplyToGroupResponse	Describes an application to join a group
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
ApiErrorWrapper	The basic wrapper around every failed API response
ApplyToGroupRequest	Creates an application to join a group. Calling this while a group application already exists will return the same application instead of an error and will not refresh the time before the application expires. By default, if the entity has an invitation to join the group outstanding, this will accept the invitation to join the group instead and return an error indicating such, rather than creating a duplicate application to join that will need to be cleaned up later. Returns information about the application or an error indicating an invitation was accepted instead.
ApplyToGroupResponse	Describes an application to join a group
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
EntityWithLineage	Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity.

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

ApplyToGroupRequest

Creates an application to join a group. Calling this while a group application already exists will return the same application instead of an error and will not refresh the time before the application expires. By default, if the entity has an invitation to join the group outstanding, this will accept the invitation to join the group instead and return an error indicating such, rather than creating a duplicate application to join that will need to be cleaned up later. Returns information about the application or an error indicating an invitation was accepted instead.

Name	Type	Description
AutoAcceptOutstandingInvite	boolean	Optional, default true. Automatically accept an outstanding invitation if one exists instead of creating an application
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

ApplyToGroupResponse

Describes an application to join a group

Name	Type	Description
Entity	EntityWithLineage	Type of entity that requested membership
Expires	string	When the application to join will expire and be deleted
Group	EntityKey	ID of the group that the entity requesting membership to

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

EntityWithLineage

Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity.

Name	Type	Description
Key	EntityKey	The entity key for the specified entity
Lineage	EntityKey	Dictionary of entity keys for related entities. Dictionary key is entity type.

Error Codes

Name	Code
EntityBlockedByGroup	1357
EntityIsAlreadyMember	1359
OutstandingInvitationAcceptedInstead	1363
RoleDoesNotExist	1358