SynqDocs
Management APIBrands

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`.

GET/v1/orgs/{org}/brands/{brand}/community-messages

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.

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

The brand's id

Match^brd_[0-9a-hjkmnp-tv-z]{26}$

Query Parameters

limit?integer

At most this many items, 200 at the most.

Range1 <= value <= 200
Default50
cursor?string

The previous page's next_cursor, for the page after it.

platform?string

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"}