Gérer les membres et invitations d'une Data Room

L'endpoint /v1/rooms/{id}/members vous permet de contrôler entièrement l'accès à une Data Room depuis votre code : récupérer la liste des participants actifs, envoyer une invitation par magic link à une adresse e-mail, et révoquer l'accès d'un membre. La révocation est douce (soft-delete) : le champ revoked_at est renseigné, l'enregistrement conservé pour l'audit. Une re-invitation du même e-mail réactive le membre sans créer de doublon.

Authentification

Toutes les requêtes exigent une clé API au format cof_live_… (production) ou cof_test_… (sandbox) dans l'en-tête Authorization: Bearer <clé>. Le scope requis varie selon la méthode : la lecture (GET) nécessite rooms:read, tandis que l'invitation et la révocation (POST, DELETE) nécessitent rooms:manage. Assurez-vous que la clé utilisée possède les bons scopes dans la console Coffrify.

Corps de la requête (POST)

Une invitation associe un e-mail à un rôle ; un magic link est généré automatiquement. Le tableau ci-dessous liste les champs acceptés.

Exemples de requêtes

Les exemples ci-dessous listent les membres, en invitent un nouveau, puis révoquent un accès. Choisissez votre langage.

# --- Lister les membres ---
curl -s https://api.coffrify.com/v1/rooms/room_01JXXXXXX/members \
  -H "Authorization: Bearer cof_live_xxxxxxxxxxxxxxxxxxxx"
 
# --- Inviter un membre ---
curl -s -X POST https://api.coffrify.com/v1/rooms/room_01JXXXXXX/members \
  -H "Authorization: Bearer cof_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"email": "alice@exemple.com", "role": "viewer"}'
 
# --- Révoquer un membre ---
curl -s -X DELETE "https://api.coffrify.com/v1/rooms/room_01JXXXXXX/members?id=mbr_01JYYYYYY" \
  -H "Authorization: Bearer cof_live_xxxxxxxxxxxxxxxxxxxx"

Réponses

GET retourne un objet list contenant le tableau data des membres, triés par rôle décroissant. POST retourne le membre créé ou réactivé (HTTP 201) avec le magic_link à transmettre au collaborateur. DELETE retourne { "ok": true } (HTTP 200).

// GET /v1/rooms/{id}/members
{
  "object": "list",
  "data": [
    {
      "user_id": "usr_01JABCDEF",
      "email": "alice@exemple.com",
      "role": "viewer",
      "last_active_at": "2026-06-05T14:23:11.000Z"
    },
    {
      "user_id": null,
      "email": "bob@exemple.com",
      "role": "reviewer",
      "last_active_at": null
    }
  ]
}
 
// POST /v1/rooms/{id}/members  →  201
{
  "id": "mbr_01JYYYYYY",
  "email": "alice@exemple.com",
  "role": "viewer",
  "magic_link": "https://files.coffrify.com/room/ma-data-room-m-a?t=a1b2c3d4e5f6"
}
 
// DELETE /v1/rooms/{id}/members?id={memberId}  →  200
{
  "ok": true
}

Erreurs

Les erreurs concernent surtout une room introuvable, un membre déjà présent ou un scope insuffisant. Le tableau ci-dessous indique la résolution.

Voir aussi

• Créer et lister les Data Rooms
• Ajouter des documents à une Data Room
• Invitations workspace (membres internes)
• Authentification et scopes API
• Référence complète : rooms members