Deel: Disable an app
Deel apps.disableAppById: arguments, response, policy and SDK examples.
← Apps operations · Get started
Operation deel.apps_disableappbyid_v2026_11_04
Provider route: POST /apps/{app_id}/disable. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["apps"]["disableAppById"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.apps.disableAppById(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.apps.disable_app_by_id(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.app_id | string | Required within parent | Format: uuid |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Enable an app — 200 response body |
Referenced models: Enable an app — 200 response body
Schemas
Section titled “Schemas”Enable an app — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Enable an app — 200 response body — data An app that belongs to your organization. |
Referenced models: Enable an app — 200 response body — data
Enable an app — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An app that belongs to your organization. |
api_access | string | Required within parent | Whether API access is switched on for the app: `disabled` after the app is disabled, by you or by Deel, until it is enabled again. Known values: enabled, disabled |
audience | string | Required within parent | Whom the app acts for: `personal` for the user who authorizes it, `organization` for the organization. Known values: personal, organization |
client_type | string | Required within parent | Whether the app can keep a secret. `confidential` apps authenticate with a client secret. Known values: public, confidential |
created_at | string | Required within parent | Time at which the app was created. Format: date-time |
created_by | JSON | Required within parent | Who created the app, or null when unknown. |
created_by (anyOf 1) | Model | Alternative | Expand Enable an app — 200 response body — data / created_by / status: active, left |
created_by (anyOf 2) | null | Alternative | |
description | string | Required within parent | What the app does. Empty when none was set. |
id | string | Required within parent | Unique identifier of the app. Format: uuid |
logo_url | string | Required within parent | URL of the app logo. Empty when the app has no logo. |
name | string | Required within parent | Name of the app. |
redirect_uris | array | Required within parent | URLs Deel may send the user back to after they authorize the app. |
redirect_uris[] | string | Each item | |
type | string | Required within parent | Kind of app. Integration apps connect your organization to Deel. Known values: integration |
updated_at | string | Required within parent | Time at which the app was last updated. Format: date-time |
website_url | string | Required within parent | Website of the app. Empty when none was set. |
Referenced models: Enable an app — 200 response body — data / created_by / status: active, left
Enable an app — 200 response body — data / created_by / status: active, left
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Who created the app, or null when unknown. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | Name of the person who created the app. |
name (anyOf 2) | null | Alternative | Name of the person who created the app. |
status | string | Required within parent | Whether the creator still belongs to your organization (`active`) or no longer does (`left`). Known values: active, left |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.apps_disableappbyid_v2026_11_04. Catalog operation: apps_disableappbyid_v2026_11_04. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Refused by default. This operation revokes every token issued to an app the organization owns, which includes this connection’s own OAuth token when the connection uses that app as its client, so Alter refuses it on every connection with credential_minting_refused unless an organization admin allows it: a credential_minting rule naming provider deel and operation deel.apps_disableappbyid_v2026_11_04 (or apps_disableappbyid_v2026_11_04). See Allow an operation that hands over a credential.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["apps:write"]
Pinned headers: {"X-Version": "2026-11-04"}