Groups - Add Members

  • Reference
Service:
Groups
API Version:
240412

Adds members to a group or role.

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

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
Members True

EntityKey[]

List of entities to add to the group. Only entities of type title_player_account and character may be added to groups.
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
RoleId

string

Optional: The ID of the existing role to add the entities to. If this is not specified, the default member role for the group will be used. Role IDs must be between 1 and 64 characters long.

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
AddMembersRequest

Adds members to a group or role. Existing members of the group will added to roles within the group, but if the user is not already a member of the group, only title claimants may add them to the group, and others must use the group application or invite system to add new members to a group. Returns nothing if successful.
ApiErrorWrapper

The basic wrapper around every failed API response
EmptyResponse
EntityKey

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

AddMembersRequest

Adds members to a group or role. Existing members of the group will added to roles within the group, but if the user is not already a member of the group, only title claimants may add them to the group, and others must use the group application or invite system to add new members to a group. Returns nothing if successful.

Name Type Description
CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Group

EntityKey

The identifier of the group
Members

EntityKey[]

List of entities to add to the group. Only entities of type title_player_account and character may be added to groups.
RoleId

string

Optional: The ID of the existing role to add the entities to. If this is not specified, the default member role for the group will be used. Role IDs must be between 1 and 64 characters long.

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
RoleDoesNotExist 1358