SynqDocs
Management APIApps

Disable an app

Turns the app off: it signs no one in and gets no tokens until it is enabled again, and its settings stay as they are. Needs `org.apps.edit`. Recorded as `app.updated`.

POST/v1/orgs/{org}/brands/{brand}/apps/{app}/disable

Turns the app off: it signs no one in and gets no tokens until it is enabled again, and its settings stay as they are. Needs org.apps.edit. Recorded as app.updated.

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

The app's client_id: an app_… id, or the URL of the metadata document an app registered itself with

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/apps/app_01h455vb4pex5vsknk084sn02q/disable" \  -H "Authorization: Bearer $SYNQ_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "app_01h455vb4pex5vsknk084sn02q",  "brand_id": "brd_01h455vb4pex5vsknk084sn02q",  "name": "Acme",  "app_type": "web",  "source": "dashboard",  "first_party": true,  "own_ui_sign_in": true,  "sign_in_methods": [    "email",    "custom-acme-guild"  ],  "test_sign_ins": true,  "sign_in_claims": true,  "disabled": true,  "development": true,  "redirect_uris": [    "https://app.acme.example"  ],  "post_logout_redirect_uris": [    "https://app.acme.example"  ],  "backchannel_logout_uri": "https://app.acme.example",  "backchannel_logout_session_required": true,  "client_uri": "https://app.acme.example",  "logo_uri": "https://app.acme.example",  "policy_uri": "https://app.acme.example",  "tos_uri": "https://app.acme.example",  "initiate_login_uri": "https://app.acme.example",  "jwks_uri": "https://app.acme.example",  "token_endpoint_auth_method": "client_secret_basic",  "pkce_optional": true,  "spa_refresh_tokens": true,  "refresh_token_reuse_window_seconds": 0,  "previous_secret_expires_at": "2026-10-21T12:00:00.000Z",  "last_used_at": "2026-10-21T12:00:00.000Z",  "created_at": "2026-10-21T12:00:00.000Z",  "warnings": [    {      "code": "loopback_redirect_uris",      "message": "string"    }  ]}