SynqDocs
Management APITelegram groups

Set up a Telegram group's window

Saves what is sent and keeps the rest: before announcing, any setting; after, only quiet hours, `name_unverified`, `message_reachable` and `headline` (409 for the rest: the deadline moves only later, with extend, and the countdown moves to another topic with move). What its messages call the brand’s members is the brand’s, `members_called` on `PATCH /v1/orgs/{org}/brands/{brand}/community-messages`. Answers the window with its schedule for these settings. The group needs a token gate that lets people in, with `existing_members: verify` (409 otherwise, with the fix). Needs `org.integrations.edit`. A change after announcing is recorded as `telegram_group.window_updated`.

PUT/v1/orgs/{org}/telegram-groups/{group}/window

Saves what is sent and keeps the rest: before announcing, any setting; after, only quiet hours, name_unverified, message_reachable and headline (409 for the rest: the deadline moves only later, with extend, and the countdown moves to another topic with move). What its messages call the brand’s members is the brand’s, members_called on PATCH /v1/orgs/{org}/brands/{brand}/community-messages. Answers the window with its schedule for these settings. The group needs a token gate that lets people in, with existing_members: verify (409 otherwise, with the fix). Needs org.integrations.edit. A change after announcing is recorded as telegram_group.window_updated.

Authorization

bearer
AuthorizationBearer <token>

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

org*string

The org's id

Match^org_[0-9a-hjkmnp-tv-z]{26}$
group*string

The Telegram group's id

Match^tgg_[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

curl -X PUT "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/telegram-groups/tgg_01h455vb4pex5vsknk084sn02q/window" \  -H "Authorization: Bearer $SYNQ_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "notice_days": 365,    "deadline_time": "18:00",    "time_zone": "America/New_York",    "quiet_hours": {      "from": "22:00",      "to": "09:00"    },    "name_unverified": true,    "message_reachable": true,    "headline": "Token gate: ROD.AI is becoming a home for holders and users of our products.",    "topic": 4  }'
{  "group": "string",  "state": "draft",  "notice_days": 0,  "deadline_time": "string",  "time_zone": "string",  "quiet_hours": {    "from": "22:00",    "to": "09:00"  },  "name_unverified": true,  "message_reachable": true,  "headline": "string",  "topic": 0,  "forum": true,  "on_lost": "mute",  "topics": [    {      "id": 0,      "name": "Acme",      "closed": true    }  ],  "starts_at": "2026-10-21T12:00:00.000Z",  "ends_at": "2026-10-21T12:00:00.000Z",  "paused_at": "2026-10-21T12:00:00.000Z",  "extended_at": "2026-10-21T12:00:00.000Z",  "members_listed_at": "2026-10-21T12:00:00.000Z",  "members_list_complete": true,  "closed_at": "2026-10-21T12:00:00.000Z",  "schedule": [    {      "reminder": "m1",      "kind": "monthly",      "at": "2026-10-21T12:00:00.000Z",      "message_reachable": true,      "names": true,      "done": true    }  ],  "counts": {    "members": 0,    "admins": 0,    "verified": 0,    "to_verify": 0,    "unknown": 0,    "settled": 0  },  "deadline": {    "per_minute": 0,    "minutes": 0  },  "problem": "members_unknown",  "problem_detail": "string",  "announce_queued_at": "2026-10-21T12:00:00.000Z",  "announce_failure": "string",  "move": {    "from_topic": 0,    "requested_at": "2026-10-21T12:00:00.000Z",    "waits_until": "2026-10-21T12:00:00.000Z"  }}