Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Global Commands

Get global commands

get

Retrieves all global commands for the specified store.

Authorizations
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

Represents a global command in the system. Global commands are instructions that can be executed across a store's environment.

idstring · flake-idRequiredExample: 411486491630370816
store_idstring · flake-idRequiredExample: 411486491630370816
stagestring · enumRequired

Defines the stages at which product commands can be executed.

Possible values:
contentstringRequired

The actual command content to be executed.

online_onlybooleanRequired

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

override_execute_on_gameserver_idsstring · flake-id[]Required

List of specific game server IDs where this command should be executed, overriding default behavior.

Example: 411486491630370816
execution_rulestring · enumRequiredPossible values:
created_atstring · date-timeRequired

Timestamp when the command was created.

updated_atstring · nullableOptional

Optional timestamp indicating when the command was last updated. Null if the command has never been updated.

get/v1/stores/{storeId}/global-commands
GET /v1/stores/{storeId}/global-commands HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "stage": "invalid",
    "content": "text",
    "online_only": true,
    "override_execute_on_gameserver_ids": [
      "411486491630370816"
    ],
    "execution_rule": "invalid",
    "created_at": "2026-01-01T00:00:00.000Z",
    "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
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

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_idsstring · flake-id[] · nullableOptional

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

Example: 411486491630370816
execution_rulestring · enumRequiredPossible values:
Responses
200

OK

application/json

Represents a global command in the system. Global commands are instructions that can be executed across a store's environment.

idstring · flake-idRequiredExample: 411486491630370816
store_idstring · flake-idRequiredExample: 411486491630370816
stagestring · enumRequired

Defines the stages at which product commands can be executed.

Possible values:
contentstringRequired

The actual command content to be executed.

online_onlybooleanRequired

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

override_execute_on_gameserver_idsstring · flake-id[]Required

List of specific game server IDs where this command should be executed, overriding default behavior.

Example: 411486491630370816
execution_rulestring · enumRequiredPossible values:
created_atstring · date-timeRequired

Timestamp when the command was created.

updated_atstring · nullableOptional

Optional timestamp indicating when the command was last updated. Null if the command has never been updated.

post/v1/stores/{storeId}/global-commands
POST /v1/stores/{storeId}/global-commands HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "stage": "invalid",
  "content": "text",
  "online_only": true,
  "override_execute_on_gameserver_ids": [
    "411486491630370816"
  ],
  "execution_rule": "invalid"
}
{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "stage": "invalid",
  "content": "text",
  "online_only": true,
  "override_execute_on_gameserver_ids": [
    "411486491630370816"
  ],
  "execution_rule": "invalid",
  "created_at": "2026-01-01T00:00:00.000Z",
  "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
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

No content
delete/v1/stores/{storeId}/global-commands/{globalCommandId}
DELETE /v1/stores/{storeId}/global-commands/{globalCommandId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

No content

Update global command

patch

Updates a global command for a store.

Authorizations
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

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_idsstring · flake-id[] · nullableOptional

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

Example: 411486491630370816
execution_rulestring · enumRequiredPossible values:
Responses
200

OK

application/json

Represents a global command in the system. Global commands are instructions that can be executed across a store's environment.

idstring · flake-idRequiredExample: 411486491630370816
store_idstring · flake-idRequiredExample: 411486491630370816
stagestring · enumRequired

Defines the stages at which product commands can be executed.

Possible values:
contentstringRequired

The actual command content to be executed.

online_onlybooleanRequired

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

override_execute_on_gameserver_idsstring · flake-id[]Required

List of specific game server IDs where this command should be executed, overriding default behavior.

Example: 411486491630370816
execution_rulestring · enumRequiredPossible values:
created_atstring · date-timeRequired

Timestamp when the command was created.

updated_atstring · nullableOptional

Optional timestamp indicating when the command was last updated. Null if the command has never been updated.

patch/v1/stores/{storeId}/global-commands/{globalCommandId}
PATCH /v1/stores/{storeId}/global-commands/{globalCommandId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "stage": "invalid",
  "content": "text",
  "online_only": true,
  "override_execute_on_gameserver_ids": [
    "411486491630370816"
  ],
  "execution_rule": "invalid"
}
{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "stage": "invalid",
  "content": "text",
  "online_only": true,
  "override_execute_on_gameserver_ids": [
    "411486491630370816"
  ],
  "execution_rule": "invalid",
  "created_at": "2026-01-01T00:00:00.000Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "updated_at": null,
  "updated_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  }
}
PreviousGiftcards
NextInvoices

Last updated

Was this helpful?