Rattacher un document à une data-room

Attache un transfert existant à une data-room en héritant de ses protections.

Requête exemple

{
  "short_code": "a1B2c3D4"
}

Réponse exemple

{
  "id": "trf_9fQ2mK7",
  "status": "active",
  "created_at": "2026-06-01T09:14:32.000Z",
  "expires_at": "2026-07-01T00:00:00.000Z",
  "short_code": "a1B2c3D4",
  "allow_download": false,
  "transfer_title": "Comptes consolidés 2025",
  "watermark_enabled": true
}

Attache un transfert existant à une data-room en renseignant son short_code. Le transfert doit appartenir au même workspace que la clé API. Comportement notable : le document hérite des protections de la room mais uniquement par durcissement, jamais par assouplissement. Si la room a le filigrane activé (watermark_enabled), le transfert passe en filigrane forcé ; si la room interdit le téléchargement (allow_download = false), le transfert est passé en lecture seule. Les protections plus strictes déjà présentes sur le transfert ne sont jamais relâchées.

POST/v1/rooms/{id}/documentsRattache le transfert identifié par short_code à 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>. L'idempotence est active sur cet endpoint : vous pouvez fournir un header Idempotency-Key pour rejouer sans risque une requête.

Corps de la requête

Champ	Type	Requis	Description
short_code	string	oui	Code court du transfert à rattacher. Espaces en début/fin supprimés. Le transfert doit appartenir au workspace de la clé.

Réponse

Renvoie un code HTTP 201 et l'objet document mis à jour : id, short_code, transfer_title, status, expires_at, allow_download, watermark_enabled et created_at. Les champs allow_download et watermark_enabled reflètent les protections effectives après héritage des contraintes de la room.

Champ	Type	Description
id	string	Identifiant interne du transfert rattaché.
short_code	string	Code court du transfert.
transfer_title	string	Titre du transfert.
status	string	Statut du transfert.
expires_at	string\|null	Date d'expiration (ISO 8601) ou null.
allow_download	boolean	Téléchargement autorisé après héritage des règles de la room.
watermark_enabled	boolean	Filigrane forcé si la room l'impose.
created_at	string	Date de création du transfert (ISO 8601).

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 dans le workspace, ou le transfert short_code n'y est pas trouvé.	Vérifiez l'identifiant de la room et que le transfert appartient au même workspace.
409 conflict	Le transfert est déjà rattaché à une autre room.	Détachez d'abord le transfert de sa room actuelle avant de le rattacher ailleurs.
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

GET /v1/rooms/{id}/documents — lister les documents rattachés
DELETE /v1/rooms/{id}/documents — détacher un transfert de la room
GET /v1/rooms — lister les data-rooms du workspace