4 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries — datastores-api/ordered-v1

Creates a new entry with the content value provided.

Endpoint

Method: POST

Path: /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Servers:

Parameters

NameLocationRequiredDescription
universeIdpathtrueThe identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.
orderedDataStorepathtrueThe name of the ordered data store.
scopepathtrueThe name of the data store scope. See Scopes.
idquerytrueThe name of the entry.
[
  {
    "name": "universeId",
    "in": "path",
    "description": "The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "orderedDataStore",
    "in": "path",
    "description": "The name of the ordered data store.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "scope",
    "in": "path",
    "description": "The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "id",
    "in": "query",
    "description": "The name of the entry.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CreateEntryRequest"
      }
    }
  },
  "required": true
}

Responses

StatusDescription
200OK
400Bad Request: invalid orderedDataStore, scope or entry name or encoding.
403Forbidden: studio access to APIs is not allowed, incorrect API key or scope.
404Not found.
429Too Many Requests.
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Entry"
        }
      }
    }
  },
  "400": {
    "description": "Bad Request: invalid orderedDataStore, scope or entry name or encoding."
  },
  "403": {
    "description": "Forbidden: studio access to APIs is not allowed, incorrect API key or scope."
  },
  "404": {
    "description": "Not found."
  },
  "429": {
    "description": "Too Many Requests."
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": [
        "universe.ordered-data-store.scope.entry:write"
      ]
    }
  ],
  "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.",
      "in": "header",
      "name": "x-api-key"
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "OrderedDataStores"
  ],
  "description": "Creates a new entry with the content value provided.",
  "operationId": "OrderedDataStores_CreateEntry",
  "x-roblox-cloud-api-operation-name": "Create",
  "x-roblox-stability": "BETA",
  "parameters": [
    {
      "name": "universeId",
      "in": "path",
      "description": "The identifier of the experience with ordered data stores that you want to access. You can find your experience's universe ID on Creator Hub.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "orderedDataStore",
      "in": "path",
      "description": "The name of the ordered data store.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "scope",
      "in": "path",
      "description": "The name of the data store scope. See [Scopes](/cloud/guides/data-stores/request-handling.md#scopes).",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "id",
      "in": "query",
      "description": "The name of the entry.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CreateEntryRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Entry"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request: invalid orderedDataStore, scope or entry name or encoding."
    },
    "403": {
      "description": "Forbidden: studio access to APIs is not allowed, incorrect API key or scope."
    },
    "404": {
      "description": "Not found."
    },
    "429": {
      "description": "Too Many Requests."
    }
  },
  "security": [
    {
      "roblox-api-key": [
        "universe.ordered-data-store.scope.entry:write"
      ]
    }
  ],
  "x-roblox-scopes": [
    {
      "name": "universe.ordered-data-store.scope.entry:write"
    }
  ],
  "x-roblox-cloud-api-operation-code-samples": [
    {
      "language": "curl",
      "script": "curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries?id=<id>' \\\n--header 'x-api-key: <insert-api-key>' \\\n--header 'Content-Type: application/json' \\\n--data '{ \n    \"value\": <long> \n}'\n"
    }
  ],
  "x-roblox-rate-limits": {
    "description": "See [Throttling](/cloud/guides/data-stores/throttling.md)."
  },
  "x-roblox-recommended-alternatives": [
    {
      "url": "https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries",
      "httpMethod": "POST"
    }
  ]
}