SynqDocs
Management APIBrand transfers

Cancel a brand move

An owner of either org cancels a request before it is decided: it ends, and nothing moves. Cancelling it again from the same side answers the same. Needs `org.brands.transfer`. Only an owner of the org, as a person, signed in within the last 5 minutes: an API key never asks, decides or cancels a move. A person needs a sign-in at Synq from the last 5 minutes whose time Synq proved (send them to sign in with `max_age=300`), else 403 `fresh_sign_in_required`; an API key never does. A request that ended otherwise is `brand_transfer_ended` (409). Recorded as `brand.transfer_cancelled` in both orgs' logs (`cancelled_by`: `from` or `to`; Synq's staff can cancel one too, as `staff` with a reason), each also their webhooks' event.

POST/v1/orgs/{org}/brand-transfers/{transfer}/cancel

An owner of either org cancels a request before it is decided: it ends, and nothing moves. Cancelling it again from the same side answers the same. Needs org.brands.transfer. Only an owner of the org, as a person, signed in within the last 5 minutes: an API key never asks, decides or cancels a move. A person needs a sign-in at Synq from the last 5 minutes whose time Synq proved (send them to sign in with max_age=300), else 403 fresh_sign_in_required; an API key never does. A request that ended otherwise is brand_transfer_ended (409). Recorded as brand.transfer_cancelled in both orgs' logs (cancelled_by: from or to; Synq's staff can cancel one too, as staff with a reason), each also their webhooks' event.

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

The request's id

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

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/brand-transfers/btr_01h455vb4pex5vsknk084sn02q/cancel" \  -H "Authorization: Bearer $SYNQ_API_KEY"
{  "id": "string",  "brand": {    "id": "string",    "name": "Acme"  },  "from_org": {    "id": "string",    "name": "Acme"  },  "to_org": {    "id": "string",    "name": "Acme"  },  "direction": "outgoing",  "status": "pending",  "requested_by": "string",  "requested_at": "2026-10-21T12:00:00.000Z",  "expires_at": "2026-10-21T12:00:00.000Z",  "decided_at": "2026-10-21T12:00:00.000Z",  "cancelled_by": "from",  "new_default_brand_id": "string",  "close_from_org": true,  "data_responsibility_statement": "string",  "preview": {    "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    }  },  "preview_hash": "string",  "reason": "string",  "from_org_empty": true,  "notice": {    "requested_at": "2026-10-21T12:00:00.000Z",    "sent_at": "2026-10-21T12:00:00.000Z",    "recipients": 0  }}

Accept a brand move POST

The target org's owner takes another org's brand, as the request's preview showed it: the brand moves at once, with its users (signed in, the same `sub`), apps (the same client ids and secrets), issuer, domains, communities, bots and token gates. You confirm that your org becomes responsible for the brand's users' data (`confirm_data_responsibility`), and name the `preview_hash` you read: if what moves or changes is no longer what it showed, nothing moves (`transfer_preview_changed`, 409). From the move, the old org's API keys, endpoints and members stop reaching the brand, and yours with All brands reach it; it arrives as one of your brands, your default only if you have none. When it was its org's last and that org's owner chose `close_from_org`, that org closes with the move, as deleting it does. Its custom domains enter a 14-day grace if your plan lacks them. Accepting it again answers the same. Needs `org.brands.transfer`. Only an owner of the org, as a person, signed in within the last 5 minutes: an API key never asks, decides or cancels a move. A person needs a sign-in at Synq from the last 5 minutes whose time Synq proved (send them to sign in with `max_age=300`), else 403 `fresh_sign_in_required`; an API key never does. Refused with `plan_quota_exceeded` (403) when your plan has no room for another brand, `brand_transfer_blocked` (409, `reason` saying what, `detail` the fix) while something blocks it, and `brand_transfer_ended` (409) for a request that ended. Recorded as `brand.transfer_accepted` in both orgs' logs (yours is the "moved from" entry, naming `from_org` and `transfer`), each also the event of that org's All brands endpoints.

Decline a brand move POST

The target org's owner declines a request to take another org's brand: it ends, and nothing moves. Declining it again answers the same. Needs `org.brands.transfer`. Only an owner of the org, as a person, signed in within the last 5 minutes: an API key never asks, decides or cancels a move. A person needs a sign-in at Synq from the last 5 minutes whose time Synq proved (send them to sign in with `max_age=300`), else 403 `fresh_sign_in_required`; an API key never does. A request that ended otherwise is `brand_transfer_ended` (409). Recorded as `brand.transfer_declined` in both orgs' logs, each also their webhooks' event.