SynqDocs
Management APIBrands

Change a brand's words for its bots

Sets the text of each message sent (null, or Synq's wording itself, puts Synq's back) and keeps the rest. A text is plain words and line breaks, `**bold**` its only formatting: Synq escapes the rest for Telegram's HTML and Discord's markdown, so it shows as typed. It may use only its message's fill-ins (`{group}`; `{Group}` starts with a capital), must use those its message needs (a message about the deadline names `{deadline}`), and must stay within the platform's longest message with its longest fill-ins; 400 at the field otherwise, with what is wrong and the fix. Synq keeps the frame, whatever the text says: the brand's name, "Powered by Synq" as its plan shows it, the window's countdown line and every button, the Verify button among them. `verify_button` names that button (`{brand}` filled in) and needs a plan with `branding.remove_powered_by` (403 `plan_feature_unavailable` otherwise); on any other plan the button says "Verify with Synq". `members_called` is what the brand calls its members, for every message's `{members}` (`{Members}` with a capital) and `{member}`, its member profile and the dashboard's counts: `plural`, and `singular` (left out: the plural with one final s off, or as it is without one), each at most 24 characters on one line; null, or members and member, puts Synq's back. Answers the Verify button, the brand's word for its members and the messages the request named. A changed Verify message or button redraws the brand's Discord Verify messages in place. Messages go with the new words from the next one sent; a Telegram window's pinned announcement takes them at its daily update. Needs `org.integrations.edit`. Recorded as `brand.updated`, each change as `community_messages.<platform>.<message>`, `community_messages.verify_button`, `members_called` or `member_called`.

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

Sets the text of each message sent (null, or Synq's wording itself, puts Synq's back) and keeps the rest. A text is plain words and line breaks, **bold** its only formatting: Synq escapes the rest for Telegram's HTML and Discord's markdown, so it shows as typed. It may use only its message's fill-ins ({group}; {Group} starts with a capital), must use those its message needs (a message about the deadline names {deadline}), and must stay within the platform's longest message with its longest fill-ins; 400 at the field otherwise, with what is wrong and the fix. Synq keeps the frame, whatever the text says: the brand's name, "Powered by Synq" as its plan shows it, the window's countdown line and every button, the Verify button among them. verify_button names that button ({brand} filled in) and needs a plan with branding.remove_powered_by (403 plan_feature_unavailable otherwise); on any other plan the button says "Verify with Synq". members_called is what the brand calls its members, for every message's {members} ({Members} with a capital) and {member}, its member profile and the dashboard's counts: plural, and singular (left out: the plural with one final s off, or as it is without one), each at most 24 characters on one line; null, or members and member, puts Synq's back. Answers the Verify button, the brand's word for its members and the messages the request named. A changed Verify message or button redraws the brand's Discord Verify messages in place. Messages go with the new words from the next one sent; a Telegram window's pinned announcement takes them at its daily update. Needs org.integrations.edit. Recorded as brand.updated, each change as community_messages.<platform>.<message>, community_messages.verify_button, members_called or member_called.

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

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

curl -X PATCH "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/brands/brd_01h455vb4pex5vsknk084sn02q/community-messages" \  -H "Authorization: Bearer $SYNQ_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "verify_button": "Verify with {brand}",    "members_called": {      "plural": "comrods",      "singular": "comrod"    },    "messages": {      "telegram": {        "announcement": "string",        "reminder_monthly": "string",        "reminder_d60": "string",        "reminder_d45": "string",        "reminder_d30": "string",        "reminder_d21": "string",        "reminder_d14": "string",        "reminder_d7": "string",        "reminder_d3": "string",        "reminder_d1": "string",        "reminder_h3": "string",        "names": "string",        "personal": "string",        "extended": "string",        "closing": "string",        "announcement_closed": "string",        "announcement_cancelled": "string",        "join_requested": "string",        "approved": "string",        "not_yet": "string",        "declined": "string",        "grace_started": "string",        "muted": "string",        "removed": "string",        "unmuted": "string",        "qualified_again": "string",        "lapse_soon": "string",        "muted_not_verified": "string",        "removed_not_verified": "string",        "verify_to_join": "string",        "verify_here": "string",        "verified_here": "string",        "ask_to_join_first": "string",        "not_gated": "string",        "banned_here": "string",        "muted_here": "string"      },      "discord": {        "announcement": "string",        "reminder_monthly": "string",        "reminder_d60": "string",        "reminder_d45": "string",        "reminder_d30": "string",        "reminder_d21": "string",        "reminder_d14": "string",        "reminder_d7": "string",        "reminder_d3": "string",        "reminder_d1": "string",        "reminder_h3": "string",        "names": "string",        "extended": "string",        "closing": "string",        "announcement_closed": "string",        "announcement_cancelled": "string",        "verify_message": "string",        "link_reply": "string",        "verified": "string",        "not_met": "string",        "recognized": "string",        "grace": "string",        "removed": "string",        "not_verified": "string",        "qualified_again": "string",        "lapse_soon": "string"      }    }  }'
{  "brand_id": "brd_01h455vb4pex5vsknk084sn02q",  "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  },  "messages": [    {      "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    }  ]}