Requête exemple
Réponse exemple
PUT/v1/transfers/{id}/folderAssigne le transfert {id} au dossier indiqué dans le corps de la requête.Cette route classe un transfert existant dans un dossier de votre workspace. Elle met à jour le champ folder_id du transfert. L'opération est idempotente par nature : réassigner un transfert déjà classé dans le même dossier renvoie le même résultat. Avant la mise à jour, l'API vérifie que le dossier cible appartient bien au même workspace que la clé API utilisée ; un dossier d'un autre workspace est traité comme introuvable.
Authentification
Cette route nécessite une clé API valide disposant du scope folders:manage. Le transfert et le dossier sont automatiquement filtrés sur le workspace résolu depuis la clé : vous ne pouvez classer que des transferts et utiliser que des dossiers appartenant à ce workspace.
Corps de la requête
| Champ | Type | Requis | Description |
|---|---|---|---|
| folder_id | string | Oui | Identifiant du dossier cible. Doit appartenir au workspace de la clé API. Une valeur absente, vide ou non textuelle déclenche une erreur validation_error. |
L'identifiant du transfert est passé dans le chemin de l'URL ({id}), pas dans le corps.
Réponse
En cas de succès, l'API renvoie un statut 200 avec un objet contenant transfer_id (l'identifiant du transfert classé) et folder_id (l'identifiant du dossier dans lequel il a été placé). Pour retirer un transfert de son dossier, utilisez la méthode DELETE sur la même route.
Erreurs
| Code | Quand | Résolution |
|---|---|---|
| validation_error (400) | Le champ folder_id est absent, vide ou n'est pas une chaîne. | Fournissez un folder_id textuel valide dans le corps JSON. |
| scope_missing (403) | La clé API ne possède pas le scope folders:manage. | Émettez une clé avec le scope folders:manage. |
| not_found (404) | Le dossier cible n'existe pas dans le workspace, ou le transfert {id} est introuvable. | Vérifiez que le folder_id et l'identifiant de transfert appartiennent bien au workspace de la clé. |
| rate_limited (429) | Quota de requêtes par minute du workspace dépassé sur les endpoints d'écriture. | Respectez l'en-tête Retry-After avant de réessayer. |
| internal_error (500) | Erreur inattendue lors de la mise à jour en base. | Réessayez ; si l'erreur persiste, contactez le support avec le X-Request-Id. |
Voir aussi
- DELETE /v1/transfers/{id}/folder — retirer un transfert de son dossier.
- GET /v1/transfers/{id} — consulter l'état complet d'un transfert.
- GET /v1/folders — lister les dossiers du workspace.