Skip to content

Update a command

Any subset of fields - {"enabled": false} benches a command without deleting it, name renames it (the old name stops triggering immediately). Requires commands:manage.

PATCH/commands/{commandName}

Authorization

AuthorizationBearer token (tp_live_...) · headerrequired

A TipPage API key, created in Dashboard → Settings → Developer.

Path parameters

commandNamestringrequired

The command's name - its trigger without the `!` prefix.

Request body

requiredapplication/json

namestring

max length 50 · matches ^[a-z0-9_-]+$

responsestring

max length 500

permissionstring

Allowed:everyonesubscribermoderator

cooldown_secondsinteger

min 0 · max 3600

cooldown_typestring

Allowed:globalper_user

aliasesstring[]

max items 10

enabledboolean

Responses

200Updated.

commandCustomCommand

Show properties

namestring

The trigger, without the `!` prefix.

responsestring

What the bot answers. Template variables supported.

permissionstring

Who can trigger it. `subscriber` includes moderators; `moderator` includes the streamer.

Allowed:everyonesubscribermoderator

cooldown_secondsinteger

min 0 · max 3600

cooldown_typestring

`global` = one shared cooldown for the whole channel; `per_user` = each viewer gets their own.

Allowed:globalper_user

aliasesstring[]

Extra triggers for the same command, also without the `!`.

enabledboolean

created_atstring<date-time>

updated_atstring<date-time>

400Invalid fields (`invalid_command`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

401Missing or invalid API key (`missing_api_key` / `invalid_api_key`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

403The key lacks the required scope (`missing_scope`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

required_scopestring

404No such resource.

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

409The new name is already taken (`command_exists`), or an alias collides with another trigger (`alias_in_use`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X PATCH "https://api.tippage.com/v1/commands/string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "response": "string",
  "permission": "everyone",
  "cooldown_seconds": 3600,
  "cooldown_type": "global",
  "aliases": [
    "string"
  ],
  "enabled": true
}'

const response = await fetch("https://api.tippage.com/v1/commands/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "name": "string",
  "response": "string",
  "permission": "everyone",
  "cooldown_seconds": 3600,
  "cooldown_type": "global",
  "aliases": [
    "string"
  ],
  "enabled": true
})
});

import requests

response = requests.patch(
    "https://api.tippage.com/v1/commands/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "name": "string",
  "response": "string",
  "permission": "everyone",
  "cooldown_seconds": 3600,
  "cooldown_type": "global",
  "aliases": [
    "string"
  ],
  "enabled": True
},
)

Response

{
  "command": {
    "name": "discord",
    "response": "string",
    "permission": "everyone",
    "cooldown_seconds": 3600,
    "cooldown_type": "global",
    "aliases": [
      "string"
    ],
    "enabled": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}