Suspend or restore an OAuth app

POST/admin/oauth-apps/{appId}/suspension

AdminBeta: may change

A suspended app can’t be authorized, and every token it holds stops working at once. Restoring it brings its connections back.

SDK method: collector.suspendOAuthApp()
Headers: X-Request-Id

Path parameters

appIdstring (uuid)required

Request body required · application/json

SuspendOAuthApp

suspendedbooleanrequired
reasonstring or null
Required to suspend.
at most 500 characters

Responses

200OKThe app.

AdminOAuthAppResult

appAdminOAuthApprequired

6Errors400 · 404 · 409 · 413 · 429 · 500

400
invalid_request invalid_json
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
404
not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
409
app_changed
app_changed: Changed by another request at the same moment: look again.
413
payload_too_large
payload_too_large: The body is over 1,048,576 bytes, this operation’s limit.
429
rate_limited temporarily_blocked
rate_limited: Over the caller’s limit: the per-minute burst or the per-day quota (RateLimit headers; wait Retry-After seconds).
temporarily_blocked: Too many refused requests in a row: blocked for a while (Retry-After says how long).
500
internal
internal: Something went wrong on our side (quote the requestId).

curl -X POST 'https://api.collection.id/v1/admin/oauth-apps/5e7a9c1b-3d2f-4a6e-8b0c-1d3f5a7b9c2e/suspension' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "suspended": true,
    "reason": "Phishing reports."
  }'

{
  "app": {
    "id": "5e7a9c1b-3d2f-4a6e-8b0c-1d3f5a7b9c2e",
    "clientId": "app_k3v9q2m7x1c8d4f6h0j5",
    "clientType": "confidential",
    "name": "Shelfie",
    "description": "Your collection on a shelf you can share.",
    "homepageUrl": "https://shelfie.example",
    "privacyUrl": "https://shelfie.example/privacy",
    "termsUrl": null,
    "logoPath": "6f2c0a4e-3b1d-4c8e-9a7f-2d5e8b1c4a90/app-3f2a9c.webp",
    "logoUrl": "https://example.supabase.co/storage/v1/object/public/avatars/6f2c0a4e-3b1d-4c8e-9a7f-2d5e8b1c4a90/app-3f2a9c.webp",
    "redirectUris": [
      "https://shelfie.example/callback",
      "http://127.0.0.1/callback"
    ],
    "scopes": [
      "catalog:read",
      "collection:read",
      "collection:write"
    ],
    "secret": {
      "display": "ccs_live_Xq3b…",
      "createdAt": "2026-10-13T06:47:11.610Z",
      "previousExpiresAt": null
    },
    "review": {
      "status": "pending",
      "approvedScopes": [],
      "awaitingScopes": [
        "collection:write"
      ],
      "note": null,
      "requestedAt": "2026-10-13T06:47:11.610Z",
      "reviewedAt": null
    },
    "suspendedAt": "2026-10-13T06:47:11.610Z",
    "suspendedReason": "Phishing reports.",
    "connections": 0,
    "createdAt": "2026-10-13T06:47:11.610Z",
    "updatedAt": "2026-10-13T06:47:11.610Z",
    "developer": {
      "id": "6f2c0a4e-3b1d-4c8e-9a7f-2d5e8b1c4a90",
      "label": "A Developer"
    }
  }
}

Responses

200OKThe app.

AdminOAuthAppResult

appAdminOAuthApprequired

6Errors400 · 404 · 409 · 413 · 429 · 500

400
invalid_request invalid_json
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
404
not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
409
app_changed
app_changed: Changed by another request at the same moment: look again.
413
payload_too_large
payload_too_large: The body is over 1,048,576 bytes, this operation’s limit.
429
rate_limited temporarily_blocked
rate_limited: Over the caller’s limit: the per-minute burst or the per-day quota (RateLimit headers; wait Retry-After seconds).
temporarily_blocked: Too many refused requests in a row: blocked for a while (Retry-After says how long).
500
internal
internal: Something went wrong on our side (quote the requestId).

curl -X POST 'https://api.collection.id/v1/admin/oauth-apps/5e7a9c1b-3d2f-4a6e-8b0c-1d3f5a7b9c2e/suspension' \ -H "Authorization: Bearer $COLLECTOR_TOKEN" \ -H 'Content-Type: application/json' \ -d '{ "suspended": true, "reason": "Phishing reports." }'

{ "app": { "id": "5e7a9c1b-3d2f-4a6e-8b0c-1d3f5a7b9c2e", "clientId": "app_k3v9q2m7x1c8d4f6h0j5", "clientType": "confidential", "name": "Shelfie", "description": "Your collection on a shelf you can share.", "homepageUrl": "https://shelfie.example", "privacyUrl": "https://shelfie.example/privacy", "termsUrl": null, "logoPath": "6f2c0a4e-3b1d-4c8e-9a7f-2d5e8b1c4a90/app-3f2a9c.webp", "logoUrl": "https://example.supabase.co/storage/v1/object/public/avatars/6f2c0a4e-3b1d-4c8e-9a7f-2d5e8b1c4a90/app-3f2a9c.webp", "redirectUris": [ "https://shelfie.example/callback", "http://127.0.0.1/callback" ], "scopes": [ "catalog:read", "collection:read", "collection:write" ], "secret": { "display": "ccs_live_Xq3b…", "createdAt": "2026-10-13T06:47:11.610Z", "previousExpiresAt": null }, "review": { "status": "pending", "approvedScopes": [], "awaitingScopes": [ "collection:write" ], "note": null, "requestedAt": "2026-10-13T06:47:11.610Z", "reviewedAt": null }, "suspendedAt": "2026-10-13T06:47:11.610Z", "suspendedReason": "Phishing reports.", "connections": 0, "createdAt": "2026-10-13T06:47:11.610Z", "updatedAt": "2026-10-13T06:47:11.610Z", "developer": { "id": "6f2c0a4e-3b1d-4c8e-9a7f-2d5e8b1c4a90", "label": "A Developer" } } }