Appearance
Change a game's publication status
PATCH /v1/admin/store/games/{id}/status
- Operation ID:
setStoreGameStatus - Tags: Store games
- Base URL:
http://localhost:8787
Moves a game between draft, published and hidden; only published games appear in the public catalog. Audited; emits a dashboard event.
Workflow: Integration guide.
Authentication: staff Bearer JWT with permission store.write.
Authentication
- Auth: staff Bearer JWT (
Authorization: Bearer <access_token>) with the permissions below. - Required permissions:
store.write
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | yes | Greater than: 0 |
Request body
Required: yes.
Content type: application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
status | string | yes | One of: "draft", "published", "hidden" |
Responses
200
Updated game row.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (StoreGame)
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | yes | - |
slug | string | yes | - |
title | string | yes | - |
summary | string | null | yes | - |
description | string | null | yes | - |
game_type | string | yes | One of: "app", "game", "launcher" |
status | string | yes | One of: "draft", "published", "hidden" |
release_date | string | null | yes | Date, YYYY-MM-DD. |
controller_support | string | yes | One of: "none", "partial", "full" |
website | string | null | yes | - |
required_age | integer | yes | - |
legal_notice | string | null | yes | - |
license_required | boolean | yes | - |
content_description | string | null | yes | - |
metadata | object | yes | - |
created_at | string | yes | ISO 8601 timestamp. |
updated_at | string | yes | ISO 8601 timestamp. |
Errors
400
Request validation failed.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ValidationErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | yes | One of: false |
error | object | yes | - |
error.name | string | yes | One of: "ZodError" |
error.issues | object[] | yes | - |
error.issues[].code | string | yes | - |
error.issues[].path | (string | number)[] | yes | - |
error.issues[].message | string | yes | - |
Request validation
json
{
"success": false,
"error": {
"name": "ZodError",
"issues": [
{
"code": "custom",
"path": [
"field"
],
"message": "Invalid value"
}
]
}
}401
Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Stable machine-readable error code, e.g. forbidden, not_found. |
details | any | no | Optional structured context. For 403 it is { perm }. |
Error response
json
{
"error": "missing_token"
}403
Authenticated but lacking the required permission. details.perm lists the accepted permission keys.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "forbidden",
"details": {
"perm": "store.write"
}
}404
game_not_found.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "game_not_found"
}500
Unexpected server error (internal). No details are returned.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "internal"
}Examples
curl
bash
curl -X PATCH 'http://localhost:8787/v1/admin/store/games/1/status' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
--data '{"status":"draft"}'TypeScript
ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow
const response = await fetch("http://localhost:8787/v1/admin/store/games/1/status", {
method: "PATCH",
headers: {
"Authorization": `Bearer ${accessToken}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"status": "draft"
}),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
? undefined
: response.headers.get("content-type")?.includes("json")
? await response.json()
: await response.text();