Experimentation - Update Exclusion Group

Updates an existing exclusion group for a title.

POST https://titleId.playfabapi.com/Experimentation/UpdateExclusionGroup

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

string

The ID of the exclusion group to update.

Name True

string

Friendly name of the exclusion group.

CustomTags

object

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

Description

string

Description of the exclusion group.

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

EmptyResponse
UpdateExclusionGroupRequest

Given an entity token and exclusion group details this API updates the exclusion 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

UpdateExclusionGroupRequest

Given an entity token and exclusion group details this API updates the exclusion group.

Name Type Description
CustomTags

object

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

Description

string

Description of the exclusion group.

ExclusionGroupId

string

The ID of the exclusion group to update.

Name

string

Friendly name of the exclusion group.

Error Codes

Name Code
ExperimentationExclusionGroupNotFound 7018
FeatureNotConfiguredForTitle 1177