Start adding Synq’s bot to a Discord server
A link to Discord's own install screen for Synq's bot, good for 15 minutes and once: Discord asks the person which server, and shows what the bot may do there (Manage Roles, View Channels, Send Messages, Embed Links and Pin Messages; adding a bot takes Manage Server there). Discord then sends them to the API, which connects the server to the org for `brand` (fixed from then on: its members verify on its hosted pages and become its users) and sends them back to the dashboard at `return_path` with `discord` set to `connected` (and `server`), `cancelled`, `taken` (another org has it), `full` (the org has 25), `expired` (the link sat past its 15 minutes), `used` (it was used already) or `failed`. Members verify on the brand's hosted pages: they sign in the way they already do, link Discord on their member profile and show what they hold with Solana wallets, so the brand must offer wallets (400 at `brand` with the fix); it needn't offer Discord sign-in. Needs `org.integrations.edit` and a plan with token gating (403 `plan_feature_unavailable`). Recorded as `discord_server.connected` when it comes back.
/v1/orgs/{org}/discord-servers/installA link to Discord's own install screen for Synq's bot, good for 15 minutes and once: Discord asks the person which server, and shows what the bot may do there (Manage Roles, View Channels, Send Messages, Embed Links and Pin Messages; adding a bot takes Manage Server there). Discord then sends them to the API, which connects the server to the org for brand (fixed from then on: its members verify on its hosted pages and become its users) and sends them back to the dashboard at return_path with discord set to connected (and server), cancelled, taken (another org has it), full (the org has 25), expired (the link sat past its 15 minutes), used (it was used already) or failed. Members verify on the brand's hosted pages: they sign in the way they already do, link Discord on their member profile and show what they hold with Solana wallets, so the brand must offer wallets (400 at brand with the fix); it needn't offer Discord sign-in. Needs org.integrations.edit and a plan with token gating (403 plan_feature_unavailable). Recorded as discord_server.connected when it comes back.
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
curl -X POST "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/discord-servers/install" \ -H "Authorization: Bearer $SYNQ_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "brand": "string", "return_path": "/orgs/acme/integrations", "own_bot": true }'{ "url": "https://app.acme.example", "expires_at": "2026-10-21T12:00:00.000Z"}Change a connected Discord server PATCH
Changes what is sent and keeps the rest. `verify_channel`: the channel Synq's bot keeps its “Verify with Synq” message in. The bot posts it there, or edits it in place when it is there already, and deletes the one it left in another channel. Its button starts each member's verification; it ends “Powered by Synq” as the brand's pages do. The bot needs View Channel, Send Messages and Embed Links in the channel (400 at `verify_channel` with the fix; 409 `discord_unavailable` on an API with no Discord bot). `invite_url`: an invite link for the member profile's Join button (null removes it). `listed`: whether the brand's member profile lists the server (null lists it): only with a way in, an invite link, so `true` with none is refused (400 at `listed`, with the fix), and a server whose link is removed stops showing until it has one again. `verified_channel`: where verified members go, a text channel of the server, usually one the gated roles unlock. Once a role is given, the member profile's Back to Discord opens it, and the bot's “You're verified” direct message links to it; null opens the server itself. The bot needn't post there (400 at `verified_channel` for a text channel the server doesn't have). Needs `org.integrations.edit`. Recorded as `discord_server.updated` with the fields changed.
Delete a verified domain DELETE
The org no longer holds the name, and another org may prove it at once. Its people are no longer sent to the org's identity provider by their address. On any plan, so an org that moved down can clean up. Needs `org.sso.edit` across the org. Recorded as `org_domain.deleted`.