channels

Connect a Telegram channel

Validates a Telegram bot token and target chat, then stores the token encrypted. The bot must be an admin of the channel/group.

post/api/v1/channels/connect/telegram

Request

Base URL: https://api.cadencz.com (the document declares no server; this is the origin it was published from)
URL: https://api.cadencz.com/api/v1/channels/connect/telegram
Auth: HTTP bearer

Request body

bot_tokenstring required

Bot token from @BotFather.

chat_idstring required

Target channel/group — @username or numeric chat id. The bot must be an admin.

display_namestring nullable

Optional label.

Example request

{
  "bot_token": "123456:ABC-DEF...",
  "chat_id": "@mychannel",
  "display_name": "Build Notes"
}

Response

Successful Response

idstring required

workspace_idstring required

platformstring required

handlestring required

display_namestring nullable required

avatar_urlstring nullable required

statusstring required

byo_appboolean required

token_expires_atstring date-time nullable required

followersinteger required

capabilitiesobject

plan_entitledboolean

entitlement_status'available' | 'plan_paused' | 'disconnected'

plan_pause_reason'plan_required' | 'workspace_limit' | 'platform_limit' nullable

Example response

{
  "avatar_url": "https://example.com/avatar.png",
  "byo_app": false,
  "display_name": "Cadencz",
  "followers": 42,
  "handle": "cadencz.bsky.social",
  "id": "chn_123",
  "platform": "bluesky",
  "status": "connected",
  "workspace_id": "wks_123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.