# Plan applying a configuration file

> config_plan — Compare the document with the workspace: each item add · update · keep (· delete when delete_missing).

Source: https://x.builera.app/docs/en/reference/config_plan

`config_plan` · Reads saved data

Compare the document with the workspace: each item add · update · keep (· delete when delete_missing). Returns a plan_id valid 15 minutes. New growth tasks will arrive OFF and new campaigns as drafts. Nothing is written yet.

| | |
|---|---|
| REST | `POST /api/public/v1/config/plan` |
| MCP tool | `config_plan` |
| Permission needed | `infra.manage` — Owner, Manager |
| Scope group | `automation:write` |
| Group | Configuration and limits |
| Shown up front in profiles | Automation |

## Input {#input}

| Field | Type | Required | Description |
|---|---|---|---|
| `document` | object | Yes |  |
| `delete_missing` | boolean | No | Also delete groups / templates / playbooks absent from the file (never tasks, campaigns or customers). |

## Result {#output}

Returned in the `{ data, meta }` envelope, without creating a job on X. Lists include `next_cursor` and `has_more`.

## Example {#example}

### Call over REST {#example-rest}

```bash
curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/config/plan" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"document":{}}'
```

### Call over MCP {#example-mcp}

```json
{
  "method": "tools/call",
  "params": {
    "name": "config_plan",
    "arguments": {
      "document": {}
    }
  }
}
```

## Errors you may get {#errors}

| Code | HTTP | Retryable |
|---|---|---|
| [`unauthorized`](/docs/en/errors/unauthorized) | 401 | No |
| [`key_expired`](/docs/en/errors/key_expired) | 401 | No |
| [`integration_revoked`](/docs/en/errors/integration_revoked) | 401 | No |
| [`connection_not_linked`](/docs/en/errors/connection_not_linked) | 403 | No |
| [`integration_paused`](/docs/en/errors/integration_paused) | 403 | No |
| [`workspace_integrations_paused`](/docs/en/errors/workspace_integrations_paused) | 403 | No |
| [`integration_authorization_lost`](/docs/en/errors/integration_authorization_lost) | 403 | No |
| [`workspace_suspended`](/docs/en/errors/workspace_suspended) | 403 | No |
| [`forbidden`](/docs/en/errors/forbidden) | 403 | No |
| [`invalid_input`](/docs/en/errors/invalid_input) | 422 | No |
| [`rate_limited`](/docs/en/errors/rate_limited) | 429 | Yes |
| [`internal`](/docs/en/errors/internal) | 500 | Yes |

[Back to all operations](/docs/en/reference)