Modifier un invité d'un coffre

Met à jour les permissions, la note ou l'expiration d'un invité existant.

Requête exemple

{
  "note": "Accès lecture seule jusqu'à signature",
  "guest_id": "gst_8f3a21c0d4e9",
  "expires_at": "2026-08-15T00:00:00.000Z",
  "can_download": false
}

Réponse exemple

{
  "guest": {
    "id": "gst_8f3a21c0d4e9",
    "note": "Accès lecture seule jusqu'à signature",
    "email": "client@exemple.com",
    "status": "pending",
    "expires_at": "2026-08-15T00:00:00.000Z",
    "can_download": false,
    "last_accessed_at": null
  }
}

PATCH/v1/coffres/{id}/guestsMet à jour un invité d'un coffre (téléchargement, note, expiration).

Modifie les attributs d'un invité existant d'un coffre. Seuls les champs explicitement fournis sont mis à jour (patch partiel) ; si aucun champ modifiable n'est présent, l'endpoint répond 400. L'opération vérifie au préalable que le coffre appartient au workspace de la clé. Particularité : expires_at accepte explicitement la valeur null pour retirer une date d'expiration.

Authentification

Requiert une clé API valide portant le scope coffres:manage. Un token avec coffres:* ou * satisfait l'exigence. Cet endpoint est soumis à l'idempotence : fournissez un Idempotency-Key pour des réessais sûrs.

Corps de la requête

Champ	Type	Requis	Description
guest_id	string	Oui	Identifiant de l'invité à modifier, rattaché au coffre `{id}`.
can_download	boolean	Non	Active ou désactive le téléchargement. Pris en compte uniquement si booléen.
note	string	Non	Nouvelle annotation interne (trimée).
expires_at	string \| null	Non	Nouvelle date d'expiration (ISO 8601), ou `null` pour supprimer l'expiration.

Au moins un champ parmi can_download, note ou expires_at doit être présent et du bon type, sinon l'endpoint renvoie 400 validation_error ("No valid fields to update").

Réponse

Renvoie l'objet guest mis à jour avec les champs id, email, status, can_download, note, expires_at et last_accessed_at. Le champ invite_token n'est pas exposé par cet endpoint.

Erreurs

Code	Quand	Résolution
400 validation_error	`guest_id` manquant, ou aucun champ modifiable valide.	Fournir `guest_id` et au moins un champ valide à mettre à jour.
401 invalid_api_key	Clé absente, mal préfixée ou introuvable.	Vérifier l'en-tête Authorization.
403 scope_missing	La clé ne porte pas `coffres:manage`.	Émettre une clé avec le bon scope.
404 not_found	Le coffre n'existe pas dans le workspace.	Vérifier `{id}` et le workspace de la clé.
429 rate_limited	Quota par minute dépassé.	Respecter `Retry-After` puis réessayer.
500 internal_error	Échec de la mise à jour en base.	Réessayer avec le même `Idempotency-Key` ; contacter le support.

Voir aussi

GET /v1/coffres/{id}/guests — lister les invités et leurs permissions
POST /v1/coffres/{id}/guests — créer ou réémettre une invitation
DELETE /v1/coffres/{id}/guests — révoquer un invité