List a brand's words for its bots
Every message Synq's Telegram and Discord bots send about the brand's groups, servers and roles, Telegram's then Discord's, in the dashboard's order (`platform` for one platform's): the brand's text (null for Synq's), Synq's wording, the fill-ins each takes with an example in the brand's own names, what each must name, its longest, and the buttons Synq attaches whatever it says. `…/community-messages/frame` has the brand's look and the Verify button. Needs `org.integrations.view`.
/v1/orgs/{org}/brands/{brand}/community-messagesEvery message Synq's Telegram and Discord bots send about the brand's groups, servers and roles, Telegram's then Discord's, in the dashboard's order (platform for one platform's): the brand's text (null for Synq's), Synq's wording, the fill-ins each takes with an example in the brand's own names, what each must name, its longest, and the buttons Synq attaches whatever it says. …/community-messages/frame has the brand's look and the Verify button. Needs org.integrations.view.
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}$The brand's id
^brd_[0-9a-hjkmnp-tv-z]{26}$Query Parameters
At most this many items, 200 at the most.
1 <= value <= 20050The previous page's next_cursor, for the page after it.
Only this platform’s messages: telegram or discord
Value in
- "telegram"
- "discord"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/brands/brd_01h455vb4pex5vsknk084sn02q/community-messages" \ -H "Authorization: Bearer $SYNQ_API_KEY"{ "data": [ { "platform": "telegram", "message": "announcement", "label": "string", "description": "string", "section": "window", "sent": "group", "text": "string", "default": "string", "fill_ins": [ { "name": "group", "description": "string", "example": "Acme Holders", "optional": true } ], "required": [ [ "deadline" ] ], "max_length": 0, "limit": 0, "buttons": [ "Verify with Synq", "Open my profile" ], "embed": true } ], "next_cursor": "string"}Read what Synq keeps around a brand's words, and its word for its members GET
The brand's look as its bots draw it (its name, logo, accent color, and whether its messages end "Powered by Synq"), the Verify button (the brand's text, what it says now, and whether the org's plan lets it name it: `branding.remove_powered_by`, Scale and Enterprise), and what the brand calls its members, plural and singular, which every message's `{members}` and `{member}`, its member profile and the dashboard's counts say. Needs `org.integrations.view`.
Read a brand's custom domain GET
Its DNS record, what Synq last saw there, its certificate and whether it answers yet. Needs `org.brands.view`, on any plan.