# Set delete protection of an app

> Turn delete protection on or off for one app of the sync. With it on, a record deleted in the other app is kept in this app. Turning it off releases the deletes held back so far.

Source: https://docs.stacksync.com/api-reference/syncs/set_sync_app_delete_protection

`POST https://api.stacksync.com/v1/workspaces/{workspace_id}/bases/{base_id}/apps/{app_id}/delete-protection`

- Operation: `set_sync_app_delete_protection`
- Resource: Syncs
- Access: writes data

## Authentication

- `Authorization: Bearer <key>`: A workspace API key (workspace_…, created by a workspace owner under Workspace settings > Stacksync API) acts with editor rights on that workspace only; a user API key (user_…, created under Profile > Stacksync API) acts as that user in every workspace they belong to. POST, PUT and PATCH requests must send Content-Type: application/json. Every authentication failure answers 403.
- `Content-Type: application/json` on every request with a body.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `workspace_id` | integer | Yes | The workspace the resources belong to |
| `base_id` | string (uuid) | Yes | The sync (a sync is called a base in these paths) |
| `app_id` | string | Yes | One of the two apps of the sync, by its app_id (read it from the sync) |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `region` | string (besg \| usnv) | Yes | Data region of the sync |

## Request body

`application/json`. The setting to apply

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string (ON \| OFF) | Yes | `ON` keeps deletes from reaching the app, `OFF` lets them through again |

## Returns

### 200 Delete protection set

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `msg` | string | Yes | `Successfully Toggled Delete Protection for app` |
| `app_id` | string | Yes | The app |

## Example request

```bash
curl -X POST "https://api.stacksync.com/v1/workspaces/{workspace_id}/bases/{base_id}/apps/{app_id}/delete-protection?region=besg" \
  -H "Authorization: Bearer $STACKSYNC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "ON"
}'
```

## Example response (200)

```json
{
  "msg": "Successfully Toggled Delete Protection for app",
  "app_id": "b71d04e5"
}
```

## Errors

| Status | Meaning | Body |
| --- | --- | --- |
| 400 | The `region` is missing or not one of besg, usnv; the body is not valid JSON; `action` is not `ON` or `OFF` (`Invalid action`); `base_id` is not a UUID; `app_id` is not an app of the sync (`Invalid app_id`); the held-back deletes could not be released when turning it off (`Error notifying schedulers of delete protection being disabled`, protection stays on) | `{ "error": string }` |
| 403 | Forbidden: invalid API key, API key of another workspace, insufficient scope, workspace unavailable, or a non-GET request without `Content-Type: application/json` | `{ "error": string }` |

## Related

- [API Reference overview](https://docs.stacksync.com/api-reference): base URLs, regions, pagination, idempotency and errors
- [Authentication](https://docs.stacksync.com/api-reference/authentication): API keys and the 403 answers
- OpenAPI document: https://docs.stacksync.com/openapi.json
- [List syncs](https://docs.stacksync.com/api-reference/syncs/list_syncs)
- [Get a sync](https://docs.stacksync.com/api-reference/syncs/get_sync)
- [Get the status of a sync](https://docs.stacksync.com/api-reference/syncs/get_sync_status)
- [Get sync metrics](https://docs.stacksync.com/api-reference/syncs/get_sync_metrics)
- [Get sync diagnostics](https://docs.stacksync.com/api-reference/syncs/get_sync_diagnostics)
- [Create a sync](https://docs.stacksync.com/api-reference/syncs/create_sync)
- [Update sync settings](https://docs.stacksync.com/api-reference/syncs/update_sync_settings)
- [Edit a sync](https://docs.stacksync.com/api-reference/syncs/edit_sync)
- [Delete a sync](https://docs.stacksync.com/api-reference/syncs/delete_sync)
- [Rename a sync](https://docs.stacksync.com/api-reference/syncs/rename_sync)
- [Switch a sync on or off](https://docs.stacksync.com/api-reference/syncs/switch_sync)
- [Set the change capture method](https://docs.stacksync.com/api-reference/syncs/set_sync_app_cdc_method)
- [Set the rate limit of an app](https://docs.stacksync.com/api-reference/syncs/set_sync_app_rate_limit)
- [Set Salesforce Bulk API access](https://docs.stacksync.com/api-reference/syncs/set_sync_app_bulk_api_access)