Groups - Change Member Role

  • Reference
Service:
Groups
API Version:
240412

Changes the role membership of a list of entities from one role to another.

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

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 move between roles in the group. All entities in this list must be members of the group and origin role.
OriginRoleId True

string

The ID of the role that the entities currently are a member of. Role IDs must be between 1 and 64 characters long.
CustomTags

object

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

string

The ID of the role that the entities will become a member of. This must be an existing role. 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
ApiErrorWrapper

The basic wrapper around every failed API response
ChangeMemberRoleRequest

Changes the role membership of a list of entities from one role to another in in a single operation. The destination role must already exist. This is equivalent to adding the entities to the destination role and removing from the origin role. Returns nothing if successful.
EmptyResponse
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

ChangeMemberRoleRequest

Changes the role membership of a list of entities from one role to another in in a single operation. The destination role must already exist. This is equivalent to adding the entities to the destination role and removing from the origin role. 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.).
DestinationRoleId

string

The ID of the role that the entities will become a member of. This must be an existing role. Role IDs must be between 1 and 64 characters long.
Group

EntityKey

The identifier of the group
Members

EntityKey[]

List of entities to move between roles in the group. All entities in this list must be members of the group and origin role.
OriginRoleId

string

The ID of the role that the entities currently are a member of. Role IDs must be between 1 and 64 characters long.

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