タグのゲームを変更

POST

/rest/v1/updateTagGames

curl --request POST \
  --url https://game.retrogather.com/rest/v1/updateTagGames \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "tagId": 1, "mode": "add", "gameIds": [ 1 ], "revision": "example" }'

LIGHT+. Tags / タグ割当: add, remove, or replace gameIds for one tag. replace requires the full set plus the tag revision.

Plans: LIGHT / PREMIUM. Scopes: library:write.

Authorizations

• apiKey

Request Body^required

Media typeapplication/json

object

tagId

required

integer

mode

required

string

Allowed values: add remove replace

gameIds

required

Array<integer>

revision

string

Responses

200

Tool result JSON (no MCP envelope). Delete previews also return 200 with confirmToken.

Media typeapplication/json

Any of:

object

object

tagId

required

integer

gameCount

required

integer

mode

required

string

Allowed values: add remove replace

revision

required

string

key

additional properties

any

object

object

code

required

string

Allowed values: plan_required not_found invalid_input unavailable already_exists revision_conflict insufficient_scope

message

string

upgradeUrl

string

field

string

allowedValues

Array<string>

scope

string

additionalScopesRequired

Array<string>

playId

string

saved

boolean

physicalId

string

physicalIds

Array<string>

createdPhysicalIds

Array<string>

deletedId

string

status

string

Allowed values: PLANNED PLAYING PAUSED COMPLETED DROPPED

items

Array<object>

object

gameId

required

integer

status

required

string

Allowed values: added already_in_library not_found

fromWishlist

boolean

key

additional properties

any

limit

object

max

required

integer

current

required

integer

requested

required

integer

key

additional properties

any

key

additional properties

any

Example

{
  "mode": "add"
}

400

Invalid_input (arguments, broken JSON body)

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

401

Missing or invalid API key

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

403

Insufficient_scope, plan_required, or access_suspended

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

404

Target or tool not found

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

409

Already_exists or revision_conflict (stale revision: re-read, then retry)

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

429

Burst or daily quota exceeded. See resetAt.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

Headers

Retry-After

integer

Seconds

500

Unexpected server failure. Retrying the same call will not help.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

503

Temporary failure or maintenance. Retry after Retry-After.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object

error

string

code

string

message

string

retryable

boolean

retryAfterSec

integer

requestId

string

resetAt

string

remaining

integer

scopes

Array<string>

upgradeUrl

string

key

additional properties

any

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

Headers

Retry-After

integer

Seconds