SynqDocs
Management APIRoles

Announce a Discord role's window

Reads the server's Verify channel and the bot's permissions there afresh, posts the announcement there, pinging the role, pins it, and starts the countdown: everyone who held the role before its gate has until the deadline to verify and keep it. Takes the settings as `PUT …/window` does, saved first. The server needs a Verify channel, and the bot Send Messages, Embed Links and Pin Messages there (409 with the fix). Synq posts it in the background (202), so the caller may go: the window answers `announce_queued_at` until it's posted, then `announced`, or `announce_failure` with the fix when nothing was posted; pressing it again meanwhile is the same announcement. What Synq knows without asking Discord (no gate, announced already, the gate off, no Verify channel, the bot gone) is refused at once. An API without a background runner posts at once (200). Recorded as `discord_role.window_announced`, as who asked. Needs `org.integrations.edit`, a plan with token gating (403 `plan_feature_unavailable`) and an API with a Discord bot (409 `discord_unavailable`).

POST/v1/orgs/{org}/discord-servers/{server}/roles/{role}/window/announce

Reads the server's Verify channel and the bot's permissions there afresh, posts the announcement there, pinging the role, pins it, and starts the countdown: everyone who held the role before its gate has until the deadline to verify and keep it. Takes the settings as PUT …/window does, saved first. The server needs a Verify channel, and the bot Send Messages, Embed Links and Pin Messages there (409 with the fix). Synq posts it in the background (202), so the caller may go: the window answers announce_queued_at until it's posted, then announced, or announce_failure with the fix when nothing was posted; pressing it again meanwhile is the same announcement. What Synq knows without asking Discord (no gate, announced already, the gate off, no Verify channel, the bot gone) is refused at once. An API without a background runner posts at once (200). Recorded as discord_role.window_announced, as who asked. Needs org.integrations.edit, a plan with token gating (403 plan_feature_unavailable) and an API with a Discord bot (409 discord_unavailable).

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}$
server*string

The Discord server's id

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

The gated role's Discord id

Match^[1-9][0-9]{16,19}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

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/discord-servers/dsv_01h455vb4pex5vsknk084sn02q/roles/1187390245566009876/window/announce" \  -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,    "headline": "Token gate: ROD.AI is becoming a home for holders and users of our products."  }'
{  "server": "string",  "role": "string",  "role_name": "string",  "state": "draft",  "notice_days": 0,  "deadline_time": "string",  "time_zone": "string",  "quiet_hours": {    "from": "string",    "to": "string"  },  "name_unverified": true,  "headline": "string",  "verify_channel": "string",  "listing": 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",  "closed_at": "2026-10-21T12:00:00.000Z",  "schedule": [    {      "reminder": "m1",      "kind": "monthly",      "at": "2026-10-21T12:00:00.000Z",      "names": true,      "done": true    }  ],  "counts": {    "holders": 0,    "verified": 0,    "to_verify": 0,    "settled": 0  },  "problem": "members_unknown",  "problem_detail": "string",  "announce_queued_at": "2026-10-21T12:00:00.000Z",  "announce_failure": "string"}