POST /v1/universes/{universeId}/configuration/playtesters/eligibility — openapi

Check whether each candidate user can currently be added as a private playtester.

Endpoint

Method: POST

Path: /v1/universes/{universeId}/configuration/playtesters/eligibility

Servers:

https://develop.roblox.com

Parameters

Name	Location	Required	Description
universeId	path	true	The universe Id.

[
  {
    "in": "path",
    "name": "universeId",
    "description": "The universe Id.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Request Body

The candidate playtesters to evaluate.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaytestersRequest"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaytestersRequest"
      }
    }
  },
  "description": "The candidate playtesters to evaluate.",
  "required": true
}

Responses

Status	Description
200	OK
400	1: The universe does not exist. 48: The playtesters list is missing or empty. 49: Too many playtesters were specified in a single request.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 2: You are not authorized to configure this universe.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaytesterEligibilityResponse"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaytesterEligibilityResponse"
        }
      }
    }
  },
  "400": {
    "description": "1: The universe does not exist.\r\n48: The playtesters list is missing or empty.\r\n49: Too many playtesters were specified in a single request."
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "0: Token Validation Failed\r\n2: You are not authorized to configure this universe."
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "summary": "Check whether each candidate user can currently be added as a private playtester.",
  "parameters": [
    {
      "in": "path",
      "name": "universeId",
      "description": "The universe Id.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaytestersRequest"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaytestersRequest"
        }
      }
    },
    "description": "The candidate playtesters to evaluate.",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaytesterEligibilityResponse"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Api.Develop.Models.PlaytesterEligibilityResponse"
          }
        }
      }
    },
    "400": {
      "description": "1: The universe does not exist.\r\n48: The playtesters list is missing or empty.\r\n49: Too many playtesters were specified in a single request."
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "0: Token Validation Failed\r\n2: You are not authorized to configure this universe."
    }
  },
  "servers": [
    {
      "url": "https://develop.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ]
}