> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Ordner löschen

> Löschen Sie einen Ordner und entfernen Sie die Ordnerzuordnung seiner Projekte. Die Projekte bleiben verfügbar.

Löschen Sie einen Ordner und entfernen Sie die Ordnerzuordnung seiner Projekte. Die Projekte bleiben verfügbar.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/folders_delete
```

## Authentifizierung und Berechtigungen

<ParamField header="x-api-key" type="string" required>
  Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt.
  OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.
</ParamField>

Erforderliche Berechtigungen: `folders:write`.

Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.

## Parameter

<ParamField body="requestId" type="string">
  An der Transportschnittstelle optional: Bei fehlender Angabe fügt der Server vor der Validierung eine Kennung ein. Geben Sie eine eigene stabile UUID v4 an, um eine verlorene Antwort sicher wiederherstellen zu können.

  Format: "uuid". Muster: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`.
</ParamField>

<ParamField body="folderId" type="string" required>
  Textwert.

  Mindestlänge: 1. Höchstlänge: 200. Muster: `^[^/]+$`.
</ParamField>

<Accordion title="Vollständiges Eingabeschema">
  Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "requestId": {
        "type": "string",
        "format": "uuid",
        "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
        "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
      },
      "folderId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/]+$"
      }
    },
    "required": ["folderId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Idempotenz

Verwenden Sie für jede Mutation eine UUID v4 in requestId oder im HTTP-Header Idempotency-Key. Verwenden Sie nach einem Netzwerkfehler dieselbe Kennung und identische Argumente erneut. Wenn Sie beides angeben, müssen die Werte übereinstimmen. Die Wiederholung einer gespeicherten Anfrage führt die Operation nicht erneut aus und verbraucht keinen weiteren monatlichen Aufruf. Fehlgeschlagene oder unterbrochene Anfragen werden nicht automatisch neu gestartet.

Jede Mutation kann HTTP 202 zurückgeben, wenn bei einem Wiederholungsversuch dieselbe Anfrage noch läuft, auch wenn ihre erste Ausführung normalerweise synchron erfolgt. Wenn die Ausführung abgeschlossen ist, resultStored aber false ist, gibt ein Wiederholungsversuch HTTP 200 mit dem gespeicherten Anfragestatus anstelle des ursprünglichen Ergebnisses zurück. Rufen Sie die Ausgabe über die für ihren Bereich vorgesehene Verlaufs-, Ergebnis- oder Downloadaktion ab.

## Anfragebeispiele

Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/folders_delete' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","folderId":"624f6bb2-e06f-4353-8d6a-33d15f34c5c2"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
    folderId: '624f6bb2-e06f-4353-8d6a-33d15f34c5c2',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/folders_delete', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.VOICECHEAP_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(input),
  });
  const body = await response.json();
  if (!response.ok) throw new Error(body.code + ': ' + body.message);
  console.log(body);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/folders_delete",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Antwort

Eine erfolgreiche erste Ausführung gibt HTTP 200 mit dem Ergebnis der Operation unter data zurück. Bei einer Wiederholung kann stattdessen der gespeicherte Anfragestatus zurückgegeben werden. Das Beispiel zeigt eine unterstützte Antwort, nicht alle optionalen Felder.

Bestätigt das Löschen des Ordners und das Entfernen seiner Projektzuweisungen.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "deleted": true,
      "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2"
    },
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
      "operation": "folders_delete",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
      "operation": "folders_delete",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
  }
  ```
</ResponseExample>

## Ergebnisfelder

| Feld | Beschreibung |
| - | - |
| `data.deleted` | true nach erfolgreicher Löschung. |
| `data.folderId` | Kennung des gelöschten Ordners. |

## Diese Anfrage wiederherstellen und abfragen

Verwenden Sie auch nach einem Verbindungsabbruch dieselbe Kennung. Wenn resultStored den Wert false hat, rufen Sie die Ausgabe über die entsprechende Verlaufs-, Ergebnis- oder Downloadaktion ab. Starten Sie niemals eine zweite Generierung, nur um den Fortschritt zu prüfen.

```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","operation":"folders_delete"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "folders_delete",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "deleted": true,
      "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2"
    }
  }
}
```

## Hinweise zur Operation

* Die zugewiesenen Projekte bleiben verfügbar. Das Löschen eines Ordners entfernt die Ordnerzuweisungen aus diesen Projekten.
* Ein Teamgast kann einen Ordner nur umbenennen, seine Anweisungen ändern oder ihn löschen, wenn alle zugeordneten Projekte für ihn zugänglich sind. Andernfalls gibt die Aktion vor jeder Änderung FOLDER\_PROJECT\_ACCESS\_DENIED zurück.

## Nutzung

Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.

## Fehler

| HTTP-Status | Code | Bedeutung oder Behebung |
| - | - | - |
| 400 | `BAD_REQUEST` | Der Ordner oder das erforderliche Arbeitsbereichskonto wurde nicht gefunden. |
| 400 | `CREDENTIAL_IN_QUERY` | Zugangsdaten wurden in einem Abfrageparameter namens access\_token oder api\_key übergeben. Senden Sie Zugangsdaten in Headern. |
| 400 | `IDEMPOTENCY_CONFLICT` | Der Header Idempotency-Key und das Feld requestId im Anfragetext müssen übereinstimmen. |
| 400 | `INVALID_REQUEST_ID` | Geben Sie eine UUID v4 als requestId oder Idempotency-Key an. |
| 400 | `VALIDATION_ERROR` | Das JSON-Objekt enthält ein nicht unterstütztes Feld, einen ungültigen Wert oder ein fehlendes erforderliches Argument. |
| 401 | `API_KEY_EXPIRED` | Der API-Schlüssel ist abgelaufen. |
| 401 | `INVALID_API_KEY` | Geben Sie einen gültigen, nicht abgelaufenen API-Schlüssel an. |
| 401 | `INVALID_CREDENTIAL` | Der Authorization-Header ist fehlerhaft oder steht im Konflikt mit x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Es wurde kein nutzbarer Berechtigungsnachweis im Header übergeben, oder er überschritt 4096 Zeichen. |
| 401 | `UNAUTHORIZED` | Der Ordner gehört nicht zum aktiven Arbeitsbereich. |
| 401 | `USER_NOT_FOUND` | Das Konto des Zugangsnachweises existiert nicht mehr. |
| 403 | `ACCOUNT_UNAVAILABLE` | Das ausführende Konto oder das Abrechnungskonto ist nicht verfügbar oder wird gerade gelöscht. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | Der Benutzer des Berechtigungsnachweises gehört mehr als einem Team an, weshalb der Abrechnungskontext nicht eindeutig ist. |
| 403 | `FOLDER_PROJECT_ACCESS_DENIED` | Dieser Ordner enthält Projekte, die Sie nicht ändern dürfen. |
| 403 | `INSUFFICIENT_SCOPE` | Erteilen Sie alle erforderlichen Berechtigungen oder verwenden Sie andere Zugangsdaten. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Die Integrationslimits des Kontos konnten nicht verifiziert werden. |
| 403 | `SUBSCRIPTION_REQUIRED` | Verwenden Sie ein aktives kostenpflichtiges Abonnement. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | Die aktuelle Teammitgliedschaft des Kontos stimmt nicht mit dem Arbeitsbereich dieser Verbindung überein. Aktualisieren Sie die Mitgliedschaft und stellen Sie die Verbindung erneut her. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Das maßgebliche Konto des Teaminhabers wurde nicht gefunden. |
| 404 | `ACCOUNT_NOT_FOUND` | Das Konto oder das Konto des aktiven Arbeitsbereichs wurde nicht gefunden. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Für dieses Konto laufen bereits 10 Integrationsaktionen. Fragen Sie eine vorhandene Anfrage ab, bevor Sie eine weitere starten. |
| 409 | `IDEMPOTENCY_CONFLICT` | Verwenden Sie eine Kennung nur mit derselben Operation und denselben Argumenten erneut. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Warten Sie auf die monatliche Zurücksetzung oder wechseln Sie den Tarif. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Warten Sie gegebenenfalls die in Retry-After angegebene Zeit und verwenden Sie zunehmend längere Warteintervalle. |
| 500 | `INTERNAL_ERROR` | Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | Die Aktion wurde ausgeführt, ihr Ergebnis konnte jedoch nicht gespeichert werden. Prüfen Sie den gespeicherten Anfragestatus und den Ressourcenverlauf, bevor Sie eine neue Generierung starten. |
| 503 | `SERVER_RESTARTING` | Der Server wird neu gestartet. Versuchen Sie es in Kürze erneut und behalten Sie bei einer Mutation dieselbe Anfragekennung bei. |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["folders:write"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.