Skip to main content
POST
Benennen Sie einen Ordner um oder aktualisieren Sie die Übersetzungsanweisungen, die auf Projekte im Ordner angewendet werden.

Authentifizierung und Berechtigungen

string
erforderlich
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.
Erforderliche Berechtigungen: folders:write. Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.

Parameter

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}$.
string
erforderlich
Textwert.Mindestlänge: 1. Höchstlänge: 200. Muster: ^[^/]+$.
string
Textwert.Mindestlänge: 1. Höchstlänge: 60.
string
Textwert.Höchstlänge: 1000.
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.

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.

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. Gibt den Ordner zurück, nachdem sein neuer Name oder seine Übersetzungsanweisungen gespeichert wurden.

Ergebnisfelder

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.
HTTP 200

Hinweise zur Operation

  • Geben Sie folderName, translationInstructions oder beides an.
  • Ordnernamen enthalten 1–60 Zeichen; Übersetzungsanweisungen enthalten höchstens 1,000 Zeichen. Führende und nachfolgende Leerzeichen werden vor dem Speichern aus den Anweisungen entfernt.
  • Eine Umbenennung aktualisiert auch den Ordnernamen, der bei den zugewiesenen Projekten angezeigt wird. Anweisungen für zukünftige Übersetzungsarbeiten werden aus dem Ordner gelesen.
  • Bei Teamgästen enthalten projectIds und angeforderte Kennzahlen nur Projekte, die sie im aktiven Team über die API erstellt haben. Gespeicherte Ergebnisse und Wiederholungen wenden dieselben Projektzugriffsprüfungen an.
  • 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