Requête exemple
Réponse exemple
Détache un transfert d'une data-room en renseignant son short_code. L'opération met simplement room_id à null sur le transfert correspondant ; le transfert lui-même n'est pas supprimé et reste accessible dans le workspace. Le détachement ne s'applique qu'au transfert qui appartient au workspace de la clé ET qui est effectivement rattaché à cette room : un short_code lié à une autre room reste intact.
/v1/rooms/{id}/documentsDétache le transfert identifié par short_code de la data-room {id}.Authentification
Requiert une clé API valide disposant du scope rooms:manage. La requête doit porter le header Authorization: Bearer <cle_api>. Le short_code est lu dans le corps JSON de la requête.
Corps de la requête
| Champ | Type | Requis | Description |
|---|---|---|---|
| short_code | string | oui | Code court du transfert à détacher. Espaces en début/fin supprimés. Le détachement n'opère que si le transfert appartient au workspace et est rattaché à cette room. |
Réponse
Renvoie un objet de confirmation simple : { "ok": true }. La réponse est identique que le transfert ait été détaché ou qu'il ne correspondait à aucune ligne (opération idempotente côté résultat) : aucune erreur n'est levée si le short_code n'est rattaché à cette room dans le workspace, tant que la room existe.
| Champ | Type | Description |
|---|---|---|
| ok | boolean | Toujours true en cas de succès de l'opération. |
Erreurs
| Code | Quand | Résolution |
|---|---|---|
| 400 validation_error | short_code absent ou vide. | Fournissez un short_code non vide dans le corps JSON. |
| 404 not_found | La room {id} n'existe pas ou n'appartient pas au workspace de la clé. | Vérifiez l'identifiant de la room et que la clé cible le bon workspace. |
| 403 scope_missing | La clé API ne possède pas le scope rooms:manage. | Régénérez une clé incluant le scope rooms:manage. |
| 401 invalid_api_key | Clé API absente, invalide, expirée ou révoquée. | Vérifiez le header Authorization et la validité de la clé. |
| 429 rate_limited | Quota de requêtes par minute du workspace dépassé. | Respectez l'en-tête Retry-After et lissez vos appels. |
| 500 internal_error | Erreur lors de la mise à jour du transfert. | Réessayez ; si le problème persiste, contactez le support avec le request_id. |
Voir aussi
- POST /v1/rooms/{id}/documents — rattacher un transfert à la room
- GET /v1/rooms/{id}/documents — lister les documents rattachés
- GET /v1/rooms — lister les data-rooms du workspace