Check app delete impact
<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>
Shows what deleting the app affects, so you can check before you call Delete app.
The response lists the template listings made from the app, the custom domains connected to it, how many users it has, and any Google Ads campaigns that are still serving. Delete app refuses while a campaign is serving, so pause those first. It works for an app that's already in the trash too.
You need editor access to the app. Passing this check doesn't mean you can delete the app: only its owner or a workspace admin can.
<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>
<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time.</Warning>
Path parameters
ID of the app to check.
ID of the app to check.
Response
What deleting the app affects.
Example response
{
"has_dependent_templates": true,
"catalog_items": [
{
"id": "68b2f0c1a4d9e7001c3b5a22",
"name": "CRM starter",
"status": "approved",
"type": "workspace"
}
],
"has_connected_domains": true,
"connected_domains": [
{
"disabled": false,
"domain": "crm.acme.com",
"id": "68c0d7e2b5a1f4001d2e9b37"
}
],
"app_users_count": 42,
"active_google_ads_campaigns": []
}Changes
Changed in 1 of the 14 revisions of this API.1
- ○
endpoint added
endpoint-added
- ○