Read what Synq keeps around a brand's words, and its word for its members
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`.
/v1/orgs/{org}/brands/{brand}/community-messages/frameThe 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.
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}$Response Body
application/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/frame" \ -H "Authorization: Bearer $SYNQ_API_KEY"{ "brand_id": "brd_01h455vb4pex5vsknk084sn02q", "look": { "name": "Acme", "logo_url": "https://app.acme.example", "icon_url": "https://app.acme.example", "accent_color": "#7c3aed", "powered_by": true }, "verify_button": { "text": "Verify with {brand}", "shown": "Verify with Synq", "default": "Verify with Synq", "renamable": true, "max_length": 0 }, "members_called": { "plural": "comrods", "singular": "comrod", "default": { "plural": "comrods", "singular": "comrod" }, "max_length": 0 }}Delete a brand DELETE
Its issuer stops at once; it is purged 30 days later, with its users and apps, and its issuer slug is never used again. The org's default brand can't be deleted: make another brand the default first (`default_brand_id` on `PATCH /v1/orgs/{org}`), or, for the org's only brand, delete the org. Needs `org.brands.edit` across the org, an org role's: a brand's own roles can't delete it. Recorded as `brand.deleted`.
List a brand's words for its bots GET
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`.