Se connecterCommencer gratuitement
Référence APIRenvoyer l'e-mail de partage d'un transfert
POST/v1/transfers/{id}/email

Renvoyer l'e-mail de partage d'un transfert

Renvoie (ou envoie à un nouveau destinataire) l'e-mail de partage d'un transfert existant.

2 min de lectureTélécharger en PDF

Requête exemple

{
  "to": "alice@acme.com",
  "message": "Bonjour Alice, voici à nouveau le lien vers les documents demandés. N'hésitez pas si besoin.",
  "subject": "Vos documents contractuels (Coffrify)"
}

Réponse exemple

{
  "note": null,
  "sent_to": "alice@acme.com",
  "subject": "Vos documents contractuels (Coffrify)",
  "share_url": "https://files.coffrify.com/x7Qa2K",
  "short_code": "x7Qa2K",
  "transfer_id": "trf_9c1f2a7b4d3e",
  "delivery_status": "sent"
}
POST/v1/transfers/{id}/emailRenvoie l'e-mail de partage d'un transfert à un destinataire donné.

Cet endpoint (re)envoie l'e-mail de partage d'un transfert existant à l'adresse indiquée dans le champ to. Il est utile lorsqu'un destinataire a perdu l'e-mail d'origine, ou pour diffuser un transfert déjà créé à un nouveau contact sans le recréer. L'envoi est traité en mode best-effort : la requête réussit (statut 202 Accepted) même si le service d'envoi sous-jacent est momentanément injoignable, auquel cas l'e-mail est journalisé pour une livraison ultérieure. Le champ delivery_status indique l'issue réelle (sent ou queued).

Le lien de partage renvoyé pointe toujours vers https://files.coffrify.com/{short_code}. Si le transfert est protégé par mot de passe, le destinataire devra saisir ce mot de passe (qui n'est jamais inclus dans l'e-mail).

Authentification

Cet endpoint nécessite une clé API valide disposant du scope transfers:write. Le transfert visé doit appartenir au workspace associé à la clé : un transfert d'un autre workspace renvoie une erreur not_found (404).

Corps de la requête

ChampTypeRequisDescription
tostringOuiAdresse e-mail du destinataire. Validée par expression régulière, normalisée en minuscules et nettoyée des espaces. Une adresse invalide renvoie une erreur validation_error (400).
subjectstringNonObjet de l'e-mail (tronqué à 200 caractères). Par défaut : 📎 {titre du transfert} via Coffrify.
messagestringNonMessage personnalisé inclus dans l'e-mail (tronqué à 2000 caractères). Par défaut : null.

Réponse

En cas de succès, l'endpoint renvoie un statut 202 Accepted avec un objet rappelant l'identifiant du transfert (transfer_id), son short_code, l'URL de partage (share_url), le destinataire effectif (sent_to) et l'objet utilisé (subject). Le champ delivery_status vaut sent si le service d'envoi a confirmé la prise en charge, sinon queued. Le champ note est null en cas d'envoi confirmé, ou contient un message explicatif lorsque l'e-mail a été mis en file d'attente pour livraison ultérieure.

Erreurs

CodeQuandRésolution
400 validation_errorLe champ to est absent ou n'est pas une adresse e-mail valide.Fournissez une adresse e-mail bien formée dans le champ to.
401 invalid_api_keyClé API absente, invalide, expirée ou révoquée.Vérifiez l'en-tête d'autorisation et la validité de la clé.
403 scope_missingLa clé API ne dispose pas du scope transfers:write.Émettez une clé incluant le scope transfers:write.
404 not_foundAucun transfert correspondant à cet id dans le workspace de la clé.Vérifiez l'identifiant du transfert et le workspace associé à la clé.
410 not_foundLe transfert existe mais a le statut deleted.Le transfert a été supprimé : recréez-le si nécessaire.
429 rate_limitedQuota de requêtes par minute du workspace dépassé.Patientez selon l'en-tête Retry-After avant de réessayer.

Voir aussi