Groups - Create Group

Reference

Service:: Groups

API Version:: 240412

Creates a new group.

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

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
GroupName	True	string	The name of the group. This is unique at the title level by default.
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	CreateGroupResponse
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
CreateGroupRequest	Creates a new group, as well as administration and member roles, based off of a title's group template. Returns information about the group that was created.
CreateGroupResponse
EntityKey	Combined entity type and ID structure which uniquely identifies a single 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

CreateGroupRequest

Creates a new group, as well as administration and member roles, based off of a title's group template. Returns information about the group that was created.

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.
GroupName	string	The name of the group. This is unique at the title level by default.

CreateGroupResponse

Name	Type	Description
AdminRoleId	string	The ID of the administrator role for the group.
Created	string	The server date and time the group was created.
Group	EntityKey	The identifier of the group
GroupName	string	The name of the group.
MemberRoleId	string	The ID of the default member role for the group.
ProfileVersion	number	The current version of the profile, can be used for concurrency control during updates.
Roles	object	The list of roles and names that belong to the group.

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
GroupNameNotAvailable	1368