SynqDocs
Management APIBrands

Preview moving a brand to another org

What moves with the brand to another org and what changes, from its own org's side, before asking: its users, apps, issuer, domains, communities and bots, whose app each sign-in provider uses now, and what blocks a move now (`blockers`, each with its fix). It shows nothing of any target: the target's owner sees its plan's side when the request reaches it. With `to_org` naming an org you own too, as a person, it is the target's side as well (its plan's gaps, its room, every blocker, with `new_default_brand` and `close_from_org` as the request would choose them) and `preview_hash`, which `move_now` names to move the brand at once; for any other org it stays the brand's side alone. Needs `org.brands.view`. A request waits 7 days for the target's owner, who accepts it (the brand moves) or declines it; either side's owner may cancel it until then.

GET/v1/orgs/{org}/brands/{brand}/transfer-preview

What moves with the brand to another org and what changes, from its own org's side, before asking: its users, apps, issuer, domains, communities and bots, whose app each sign-in provider uses now, and what blocks a move now (blockers, each with its fix). It shows nothing of any target: the target's owner sees its plan's side when the request reaches it. With to_org naming an org you own too, as a person, it is the target's side as well (its plan's gaps, its room, every blocker, with new_default_brand and close_from_org as the request would choose them) and preview_hash, which move_now names to move the brand at once; for any other org it stays the brand's side alone. Needs org.brands.view. A request waits 7 days for the target's owner, who accepts it (the brand moves) or declines it; either side's owner may cancel it until then.

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

to_org?string

The org the brand would go to. When you own it too, as a person, the answer is the target's side as well, its plan's gaps, its room and its blockers, with preview_hash, which move_now names; otherwise it is the brand's own side alone, as without it

Match^org_[0-9a-hjkmnp-tv-z]{26}$
new_default_brand?string

With to_org, when the brand is its org's default and not its last: the org's brand that would become its default, as the request names it

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

With to_org, when the brand is its org's last: true previews closing the org with the move, as the request asks it

Value in

  • "true"
  • "false"

Response Body

application/json

application/problem+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/transfer-preview" \  -H "Authorization: Bearer $SYNQ_API_KEY"
{  "users": 0,  "monthly_active_users": 0,  "apps": [    {      "client_id": "app_01h455vb4pex5vsknk084sn02q",      "name": "Acme"    }  ],  "apps_total": 0,  "issuer": "string",  "custom_domains": [    "acme.example"  ],  "sending_domain": "acme.example",  "sending_domains": [    "mail.acme.com"  ],  "discord_servers": [    {      "id": "string",      "name": "Acme"    }  ],  "telegram_groups": [    {      "id": "string",      "title": "string"    }  ],  "own_bots": [    {      "id": "string",      "platform": "discord",      "name": "Acme"    }  ],  "sign_in_providers": [    {      "provider": "google",      "app_now": "brand",      "app_after": "brand"    }  ],  "stays_as_set": {    "terms_of_service_url": "https://app.acme.example",    "privacy_policy_url": "https://app.acme.example"  },  "blockers": [    {      "reason": "transfer_pending",      "detail": "string"    }  ],  "roles_ending": {    "members": 0,    "invitations": 0  },  "plan_changes": [    {      "feature": "string",      "effect": "string"    }  ],  "apps_over_quota": {    "apps": 0,    "limit": 0  },  "to_org": {    "id": "string",    "name": "Acme"  },  "preview_hash": "string"}