Définir ou modifier le mot de passe d'un transfert

Protège un transfert par mot de passe (ou met à jour un mot de passe existant) en activant la protection à l'accès.

Requête exemple

{
  "password": "Coffre-Fort-2026"
}

Réponse exemple

{
  "short_code": "x7Qa9R",
  "transfer_id": "tr_9fK3m2Qz8vWp",
  "password_set": true
}

PUT/v1/transfers/{id}/passwordDéfinit ou remplace le mot de passe d'accès d'un transfert et active la protection.

Cet endpoint définit (ou remplace) le mot de passe protégeant l'accès à un transfert identifié par son id. À la réussite, le champ is_password_protected du transfert passe à true et le mot de passe est stocké sous forme de hachage SHA-256 salé avec le short_code du transfert. L'opération est idempotente côté ressource : appeler PUT à nouveau remplace simplement le mot de passe existant. Le mot de passe en clair n'est jamais renvoyé ni conservé.

Authentification

Requiert une clé API valide avec le scope transfers:write. Le transfert doit appartenir au workspace associé à la clé : la résolution est filtrée sur le workspace_id du contexte d'authentification, donc un transfert d'un autre workspace renvoie 404 not_found.

Corps de la requête

Champ	Type	Requis	Description
password	string	Oui	Mot de passe en clair à appliquer. Doit contenir au moins 4 caractères, sinon l'appel échoue avec `validation_error` (400). Une valeur absente ou non textuelle est traitée comme une chaîne vide et donc rejetée.

Réponse

Renvoie un objet JSON de confirmation. transfer_id reprend l'identifiant fourni dans l'URL, short_code est le code court public du transfert, et password_set vaut toujours true en cas de succès.

Champ	Type	Description
transfer_id	string	Identifiant du transfert mis à jour.
short_code	string	Code court public du transfert (sert aussi de sel au hachage du mot de passe).
password_set	boolean	Toujours `true` lorsque le mot de passe a bien été enregistré.

Erreurs

Code	Quand	Résolution
400 validation_error	Le mot de passe fait moins de 4 caractères (ou est absent).	Fournir un champ `password` d'au moins 4 caractères.
404 not_found	Aucun transfert ne correspond à cet `id` dans le workspace de la clé.	Vérifier l'identifiant et que le transfert appartient bien au workspace.
410 not_found	Le transfert existe mais a le statut `deleted`.	Le transfert est supprimé : aucune modification possible.
500 internal_error	Échec de la mise à jour en base.	Réessayer ; si l'erreur persiste, contacter le support avec le `request_id`.

Voir aussi

DELETE /v1/transfers/{id}/password : retirer la protection par mot de passe.
GET /v1/transfers/{id} : consulter l'état d'un transfert, dont is_password_protected.
POST /v1/transfers : créer un transfert.