Start connecting a Telegram group
A one-time code, good for 15 minutes, and the link that adds Synq's bot to a group as an admin and sends it there; `command` is the same for a bot already in the group. Only an admin of the group can connect it, and people verify on `brand`'s hosted pages: they sign in the way they already do, link Telegram on their member profile and show what they hold with wallets, so the brand must offer wallets (400 at `brand` with the fix otherwise); it needn't offer Telegram sign-in. Synq's bot reads the group and its own rights when the code arrives, and the group is recorded as `telegram_group.connected`. At most 25 groups per org. Needs `org.integrations.edit` and a plan with token gating (403 `plan_feature_unavailable`), and an API with a Telegram bot (409 `telegram_unavailable`).
/v1/orgs/{org}/telegram-groups/connectA one-time code, good for 15 minutes, and the link that adds Synq's bot to a group as an admin and sends it there; command is the same for a bot already in the group. Only an admin of the group can connect it, and people verify on brand's hosted pages: they sign in the way they already do, link Telegram on their member profile and show what they hold with wallets, so the brand must offer wallets (400 at brand with the fix otherwise); it needn't offer Telegram sign-in. Synq's bot reads the group and its own rights when the code arrives, and the group is recorded as telegram_group.connected. At most 25 groups per org. Needs org.integrations.edit and a plan with token gating (403 plan_feature_unavailable), and an API with a Telegram bot (409 telegram_unavailable).
Authorization
bearer An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.
In: header
Path Parameters
The org's id
^org_[0-9a-hjkmnp-tv-z]{26}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/telegram-groups/connect" \ -H "Authorization: Bearer $SYNQ_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "brand": "string", "return_path": "string", "own_bot": true }'{ "code": "SYNQ-7KQ4R-2DXMP", "link": "https://t.me/synq_robot?startgroup=SYNQ-7KQ4R-2DXMP&admin=invite_users+restrict_members+pin_messages", "command": "/connect SYNQ-7KQ4R-2DXMP", "bot": "synq_robot", "expires_at": "2026-10-21T12:00:00.000Z"}Change a connected Telegram group PATCH
Changes what is sent and keeps the rest. `listed`: whether the brand's member profile lists the group under Communities (null lists it): only with a way in, a public username, or join requests because a gate lets people in, so `true` with none is refused (400 at `listed`, with the fix). Needs `org.integrations.edit`. Recorded as `telegram_group.updated` with the fields changed.
Read a Telegram group again POST
Reads the group's title and kind, whether Synq's bot is its guard bot, and the bot's rights there from Telegram now: after an admin changed them, or the group became a supergroup. A change is recorded as `telegram_group.updated`; a bot no longer in the group as `telegram_group.bot_removed`. Needs `org.integrations.edit`, and an API with a Telegram bot (409 `telegram_unavailable`).