SynqDocs
Management APIBrands

Preview a brand's member profile

The member profile with these settings on top of what’s saved, saving nothing: the dashboard’s live phone preview. A made-up member arrives from Discord or Telegram (`from`, Discord where the brand has a server) to the brand’s real servers, groups and gates, with sample numbers and no chain read. Answers the brand’s look and the page’s view as values, which @synq/member-ui draws as members get it. Needs `org.integrations.view`.

POST/v1/orgs/{org}/brands/{brand}/member-profile/preview

The member profile with these settings on top of what’s saved, saving nothing: the dashboard’s live phone preview. A made-up member arrives from Discord or Telegram (from, Discord where the brand has a server) to the brand’s real servers, groups and gates, with sample numbers and no chain read. Answers the brand’s look and the page’s view as values, which @synq/member-ui draws as members get it. 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}$

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 POST "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/brands/brd_01h455vb4pex5vsknk084sn02q/member-profile/preview" \  -H "Authorization: Bearer $SYNQ_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "sections": {      "wallets": true,      "communities": true,      "linked_accounts": true    },    "copy": {      "sign_in_line": "To {goal}, sign in to your {brand} account.",      "finish_button": "Finish verification with {platform}"    },    "communities": [      {        "id": "string",        "listed": true      }    ],    "from": "discord"  }'
{  "look": {    "brand": {      "name": "Acme",      "support_email": "ana@acme.example",      "privacy_policy_url": "https://app.acme.example",      "terms_of_service_url": "https://app.acme.example",      "unclaimed": true    },    "primary_color": "string",    "background_color": "string",    "theme": {      "font": "system",      "heading_font": "system",      "heading_case": "upper",      "surface_color": "string",      "muted_color": "string",      "glow_color": "string",      "button_style": "pill",      "card_radius": 0,      "card_shadow": "none",      "background_image_url": "https://app.acme.example",      "background_blur": 0    },    "logo": {      "url": "https://app.acme.example",      "width": 0,      "height": 0    },    "phone_background_url": "https://app.acme.example",    "icon": "string",    "powered_by": true  },  "view": {    "brand_name": "string",    "members_called": {      "plural": "string",      "singular": "string"    },    "person": {      "name": "Acme",      "initials": "string",      "signed_in_with": "string",      "avatar": {        "kind": "image",        "url": "https://app.acme.example"      }    },    "purpose": {      "platform": "discord",      "place": "string",      "labels": [        "string"      ],      "external_name": "string",      "other_account": "string",      "linked": true,      "conditions": [        {          "text": "string",          "status": "met",          "skipped": true,          "ratio": 0,          "have": {            "held": "string",            "need": "string",            "symbol": "string"          },          "shortfall": {            "kind": null,            "amount": null,            "symbol": null          },          "period": "string",          "until": "string"        }      ],      "heading": "string",      "state": "done",      "missing": [        {          "text": "string",          "status": "met",          "skipped": true,          "ratio": 0,          "have": {            "held": "string",            "need": "string",            "symbol": "string"          },          "shortfall": {            "kind": null,            "amount": null,            "symbol": null          },          "period": "string",          "until": "string"        }      ],      "alternatives": true,      "until": "string",      "window": {        "ends_at": "2026-10-21T12:00:00.000Z",        "time_zone": "string",        "verified": true,        "left": {          "kind": null,          "days": null        }      },      "given": [        "string"      ],      "pending": true,      "now": {        "label": "string",        "state": "yours",        "note": {          "kind": null,          "shortfall": null        },        "at": "string",        "lost_reason": "stopped_qualifying",        "back": true,        "qualifies_again": true,        "admin_muted": true      },      "back_url": "https://app.acme.example"    },    "gates": [      {        "id": "string",        "name": "Acme",        "status": "met",        "where": [          {            "platform": "discord",            "label": "string"          }        ],        "conditions": [          {            "text": "string",            "status": "met",            "skipped": true,            "ratio": 0,            "have": {              "held": "string",              "need": "string",              "symbol": "string"            },            "shortfall": {              "kind": null,              "amount": null,              "symbol": null            },            "period": "string",            "until": "string"          }        ],        "mode": "all",        "glow": true      }    ],    "wallets": [      {        "id": "string",        "address": "string",        "app": "string"      }    ],    "communities": [      {        "id": "string",        "platform": "discord",        "name": "Acme",        "members": 0,        "join_url": "https://app.acme.example",        "gated": true,        "purpose": true,        "roles": [          {            "label": "string",            "state": "yours",            "note": {              "kind": null,              "shortfall": null            },            "at": "string",            "lost_reason": "stopped_qualifying",            "back": true,            "qualifies_again": true,            "admin_muted": true          }        ],        "in_group": "member",        "window": {          "ends_at": "2026-10-21T12:00:00.000Z",          "time_zone": "string",          "verified": true,          "left": {            "kind": null,            "days": null          }        },        "updates_url": "https://app.acme.example"      }    ],    "links": [      {        "method": "string",        "icon": "string",        "value": "string",        "identity_id": "idn_01h455vb4pex5vsknk084sn02q",        "signed_in_with": true,        "community": true      }    ],    "wallet_count": 0  }}