skip to content
superbot.gg

Set an @mention alias

Part of Endpoints, 9 operations. The overview covers keys, scopes and errors.

PUT /v1/aliases/{token}

Create or overwrite one personal alias; every paired device picks it up.

A caller key holding endpoints:write (Authorization: Bearer sbc_… or x-api-key: sbc_…), or a signed-in session.

Operation id setAlias in Endpoints.

Path parameters

  • token string required

Request body

application/json, required.

  • vendor string required
  • model_id string
  • label string
  • custody string

    One of envelope, device-held.

Response 200

Saved.

application/json: AliasWrite.

  • ok boolean required

    One of true.

  • token string required
  • rev integer required

Errors

StatusCodeWhat to change
400invalid_request

A parameter or body field is invalid; param names it and issues lists every problem.

401unauthorized

Send a live caller key or session as Authorization: Bearer … or x-api-key. No key yet: create one at /account/api, or sign a user in at /auth.md.

403insufficient_scope

The key lacks the scope in required_scopes; mint a key that holds it.

view .mdopenapi
Request

curl

curl -sS -X PUT "https://superbot.gg/v1/aliases/$TOKEN" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY" \
  -H "content-type: application/json" \
  -d '{"vendor":"your-vendor"}'

JavaScript

const token = 'TOKEN';
const res = await fetch(`https://superbot.gg/v1/aliases/${token}`, {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
    'content-type': 'application/json',
  },
  body: JSON.stringify({"vendor":"your-vendor"}),
});
console.log(res.status, await res.json());

Python

import os
import requests

token = "TOKEN"
res = requests.request(
    "PUT",
    f"https://superbot.gg/v1/aliases/{token}",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
        "content-type": "application/json",
    },
    json={"vendor":"your-vendor"},
)
print(res.status_code, res.json())
Response

200 Saved.

{
  "ok": true,
  "token": "your-token",
  "rev": 0
}

400 The request is malformed or a parameter is invalid; `param` names the field.

{
  "error": "invalid_request",
  "message": "A parameter or body field is invalid; param names it and issues lists every problem.",
  "doc_url": "https://superbot.gg/developers#errors-invalid_request",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

401 The bearer is missing, malformed or unknown.

{
  "error": "unauthorized",
  "message": "Send a live caller key or session as Authorization: Bearer … or x-api-key. No key yet: create one at /account/api, or sign a user in at /auth.md.",
  "doc_url": "https://superbot.gg/developers#errors-unauthorized",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

403 The key lacks a scope (insufficient_scope), is revoked, or may not call this route.

{
  "error": "insufficient_scope",
  "message": "The key lacks the scope in required_scopes; mint a key that holds it.",
  "doc_url": "https://superbot.gg/developers#errors-insufficient_scope",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}