Référence APIRetirer un transfert de son dossier
DELETE/v1/transfers/{id}/folder

Retirer un transfert de son dossier

Déclasse un transfert en remettant son dossier à null.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"folder_id": null,
"transfer_id": "trf_3a91c7e0d2f5"
}
DELETE/v1/transfers/{id}/folderRetire le transfert {id} de son dossier en remettant son `folder_id` à null.

Cette route déclasse un transfert : elle remet son champ folder_id à null, sans supprimer ni le transfert ni le dossier. L'opération est idempotente : appeler DELETE sur un transfert déjà déclassé renvoie le même résultat sans effet de bord. Le transfert est filtré sur le workspace résolu depuis la clé API.

Authentification

Cette route nécessite une clé API valide disposant du scope folders:manage. Seuls les transferts appartenant au workspace de la clé peuvent être déclassés.

Réponse

En cas de succès, l'API renvoie un statut 200 avec un objet contenant transfer_id (l'identifiant du transfert) et folder_id fixé à null, confirmant que le transfert n'appartient plus à aucun dossier.

Erreurs

CodeQuandRésolution
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 transfert {id} est introuvable dans le workspace.Vérifiez l'identifiant du transfert et qu'il appartient 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