Global Commands

Get global commands

get

Retrieves all global commands for the specified store.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store to retrieve this data for.

Example: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

get

/v1/stores/{storeId}/global-commands

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/global-commands HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "stage": "invalid",
    "content": "text",
    "online_only": true,
    "override_execute_on_gameserver_ids": [
      "411486491630370816"
    ],
    "created_at": "2025-12-12T13:18:48.809Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "updated_at": null,
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

Create global command

post

Creates a global command for a store.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store to create this data for.

Example: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

Data transfer object used for creating new global commands or updating existing ones. Supports partial updates following PATCH semantics.

stagestring · enumRequired

Defines the stages at which product commands can be executed.

Possible values:

contentstringRequired

The command content to be executed.

online_onlybooleanRequired

Indicates whether the command should only be executed when the player is online.

override_execute_on_gameserver_idsnull | arrayOptional

List of specific game server IDs where this command should be executed.

Example: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

post

/v1/stores/{storeId}/global-commands

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/global-commands HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "stage": "invalid",
  "content": "text",
  "online_only": true,
  "override_execute_on_gameserver_ids": [
    "411486491630370816"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "stage": "invalid",
  "content": "text",
  "online_only": true,
  "override_execute_on_gameserver_ids": [
    "411486491630370816"
  ],
  "created_at": "2025-12-12T13:18:48.809Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": null,
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}

Delete global command

delete

Deletes a global command for a store.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store to delete this data for.

Example: 411486491630370816

globalCommandIdstring · flake-idRequired

The ID of the command to delete.

Example: 411486491630370816

Responses

204

No Content

default

Error response

application/json

delete

/v1/stores/{storeId}/global-commands/{globalCommandId}

HTTPcURLJavaScriptPython

DELETE /v1/stores/{storeId}/global-commands/{globalCommandId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Update global command

patch

Updates a global command for a store.

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequired

The ID of the store to update this data for.

Example: 411486491630370816

globalCommandIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

Data transfer object used for creating new global commands or updating existing ones. Supports partial updates following PATCH semantics.

stagestring · enumRequired

Defines the stages at which product commands can be executed.

Possible values:

contentstringRequired

The command content to be executed.

online_onlybooleanRequired

Indicates whether the command should only be executed when the player is online.

override_execute_on_gameserver_idsnull | arrayOptional

List of specific game server IDs where this command should be executed.

Example: 411486491630370816

Responses

200

OK

application/json

default

Error response

application/json

patch

/v1/stores/{storeId}/global-commands/{globalCommandId}

HTTPcURLJavaScriptPython

PATCH /v1/stores/{storeId}/global-commands/{globalCommandId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "stage": "invalid",
  "content": "text",
  "online_only": true,
  "override_execute_on_gameserver_ids": [
    "411486491630370816"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "stage": "invalid",
  "content": "text",
  "online_only": true,
  "override_execute_on_gameserver_ids": [
    "411486491630370816"
  ],
  "created_at": "2025-12-12T13:18:48.809Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": null,
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}