Envoyer depuis un modèle

C'est l'endpoint autour duquel la plupart des intégrations sont construites : prenez un de vos modèles, affectez de vraies personnes à ses rôles et envoyez-le pour signature — le tout en un seul appel. Il n'y a pas d'étape de brouillon sur l'API.

Créer une enveloppe à partir d'un modèle et l'envoyer

Requiert le scope envelopes:send. La création et l'envoi ont lieu ensemble : si l'envoi échoue pour une raison quelconque, l'enveloppe est supprimée et une erreur est renvoyée, de sorte que vous ne laissez jamais de brouillon à moitié créé. Chaque envoi réussi consomme une des demandes de signature par API de votre plan.

Corps

Chaque destinataire associe une personne réelle à un rôle du modèle :

Exemple de requête

curl -X POST https://api2.bunnydoc.com/v1/envelopes/from-template \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "018f2c3d-4e5f-7a8b-9c0d-1e2f3a4b5c6d",
    "title": "Mutual NDA — Acme Corp",
    "sender_email": "sales@yourco.com",
    "email_subject": "Please sign: Mutual NDA",
    "email_message": "Hi Jane — please review and sign our mutual NDA. Thanks!",
    "recipients": [
      { "role": "Client", "name": "Jane Doe", "email": "jane@acme.com" }
    ]
  }'

POST /v1/envelopes/from-template HTTP/1.1
Host: api2.bunnydoc.com
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "template_id": "018f2c3d-4e5f-7a8b-9c0d-1e2f3a4b5c6d",
  "title": "Mutual NDA — Acme Corp",
  "sender_email": "sales@yourco.com",
  "email_subject": "Please sign: Mutual NDA",
  "email_message": "Hi Jane — please review and sign our mutual NDA. Thanks!",
  "recipients": [
    { "role": "Client", "name": "Jane Doe", "email": "jane@acme.com" }
  ]
}

Réponse

{
  "envelope_id": "018f9a0b-1c2d-7e3f-8a4b-5c6d7e8f9a0b",
  "status": "sent",
  "title": "Mutual NDA — Acme Corp",
  "sender": { "email": "sales@yourco.com" },
  "recipients": [
    { "role": "Client", "name": "Jane Doe", "email": "jane@acme.com" }
  ],
  "signing_urls": [
    {
      "recipient_id": "018f9a0b-2c3d-7e4f-8a5b-6c7d8e9f0a1b",
      "name": "Jane Doe",
      "email": "jane@acme.com",
      "recipient_type": "need-to-sign",
      "signing_url": "https://sign.bunnydoc.com/s/eyJhbGciOi…"
    }
  ],
  "created_at": "2026-07-28T10:20:00.000Z"
}

Personnaliser l'e-mail d'invitation

email_subject et email_message déterminent l'e-mail que reçoit chaque destinataire (ainsi que les rappels qui suivent : les rappels réutilisent l'objet, préfixé Reminder:). Si vous les omettez, les valeurs du modèle sont utilisées.

Placeholders

Les deux champs acceptent des placeholders, remplis pour chaque destinataire au moment de l'envoi. Un seul appel peut donc produire un e-mail nominatif pour chaque signataire.

{
  "template_id": "018f2c3d-4e5f-7a8b-9c0d-1e2f3a4b5c6d",
  "email_subject": "{{recipient_first_name}}, merci de signer {{envelope_title}}",
  "email_message": "<p>Bonjour {{recipient_first_name}},</p><p>Merci de relire et de signer. Expire le {{expiry_date}}.</p><p>Cordialement,<br/>{{sender_name}}</p>",
  "recipients": [
    { "role": "Client", "name": "Jane Doe", "email": "jane@acme.com" },
    { "role": "Witness", "name": "Sam Ortiz", "email": "sam@acme.com" }
  ]
}

Il n'existe volontairement aucun placeholder pour le lien de signature ni pour le code d'accès. L'e-mail comporte déjà le bouton de signature, et un code d'accès est un second facteur qui doit parvenir au destinataire par un autre canal. Utilisez GET /v1/envelopes/{id}/signing-links si votre propre système a besoin de l'URL.

Mise en forme dans email_message

Envoyez du texte brut (les sauts de ligne sont conservés) ou un petit sous-ensemble sûr de HTML :

Tout le reste est supprimé à l'entrée, y compris style, class, id, les images, les tableaux et les titres. La valeur enregistrée est la version nettoyée : ce que vous pouvez enregistrer est donc exactement ce que le destinataire reçoit.

La limite de 10 000 caractères est comptée après nettoyage : un peu de balisage superflu ne vous fera donc pas dépasser.

Erreurs

Obtenir les liens de signature d'une enveloppe envoyée

Les liens de signature permettent au système de l'expéditeur de remettre à chaque destinataire un lien direct au lieu d'attendre l'e-mail. Ils sont disponibles à tout moment après l'envoi et sont aussi renvoyés directement par l'appel d'envoi ci-dessus.

Exemple de requête

curl https://api2.bunnydoc.com/v1/envelopes/018f9a0b-1c2d-7e3f-8a4b-5c6d7e8f9a0b/signing-links \
  -H "Authorization: Bearer <access_token>"

GET /v1/envelopes/018f9a0b-1c2d-7e3f-8a4b-5c6d7e8f9a0b/signing-links HTTP/1.1
Host: api2.bunnydoc.com
Authorization: Bearer <access_token>

Réponse

{
  "signing_urls": [
    {
      "recipient_id": "018f9a0b-2c3d-7e4f-8a5b-6c7d8e9f0a1b",
      "name": "Jane Doe",
      "email": "jane@acme.com",
      "recipient_type": "need-to-sign",
      "signing_url": "https://sign.bunnydoc.com/s/eyJhbGciOi…"
    }
  ]
}

signing_url vaut null pour les destinataires qui ne signent pas (par exemple, un destinataire qui « reçoit une copie »).

Erreurs