Experimentation - Create Exclusion Group

Service:

Experimentation

API Version:

240412

Creates a new experiment exclusion group for a title.

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

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
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	CreateExclusionGroupResult
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
CreateExclusionGroupRequest	Given a title entity token and exclusion group details, will create a new exclusion group for the title.
CreateExclusionGroupResult

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

CreateExclusionGroupRequest

Given a title entity token and exclusion group details, will create a new exclusion group for the title.

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.
Name	string	Friendly name of the exclusion group.

CreateExclusionGroupResult

Name	Type	Description
ExclusionGroupId	string	Identifier of the exclusion group.

Error Codes

Name	Code
ExperimentationExclusionGroupInvalidName	7022
FeatureNotConfiguredForTitle	1177