ROroblox
Experiments

Schedules an experiment to start at a future UTC time.

Changed on

Body must include scheduledStartTime as an ISO-8601 UTC timestamp.

post/creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId}:schedule

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments/{experimentId}:schedule
  • Auth
    • API key in cookie .ROBLOSECURITY
    • or API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: universe:write

Path parameters

universeIdinteger required
experimentIdstring required

Request body

scheduledStartTimestring date-time nullable

UTC time at which the experiment should be auto-started.

Response

OK

Changes

  • bcfdc20689cdRevision changes
    • breaking

      the //// request property format changed from no format to date-time (media type: application/json-patch+json)

    • breaking

      the //// request property format changed from no format to date-time (media type: application/json)

    • breaking

      the //// request property format changed from no format to date-time (media type: text/json)

    • breaking

      the //// request property format changed from no format to date-time (media type: application/*+json)

    • breaking

      the //////////////////////////////// response's property type changed from string to boolean for status

    • breaking

      the //////////////////////////////// response's property type changed from string to number, and format from no format to double for status

    • breaking

      the //////////////////////////////// response's property type changed from string to integer, and format from no format to int64 for status

    • breaking

      the ////////////////////// response's property type changed from string to no type for status

    • info

      added to the ////////////////////// response property allOf list for the response status

  • 7c6787738100Revision changes
    • warning

      added the new EXPERIMENT_API_ERROR_TYPE_CONFIGS_KEY_HAS_RESERVED_PREFIX enum value to the ////////////// response property for the response status