B2B (v1)

Rendu d’une lettre : document structuré (segments avec champs à compléter), texte, champs manquants

post/v1/letters/{slug}/render

Request

Base URL: https://api.vitef.com
URL: https://api.vitef.com/v1/letters/{slug}/render
Auth: HTTP bearer

Path parameters

slugstring required

Headers

Idempotency-Keystring

Rend la requête rejouable sans effet en double pendant 24 h (UUID v4 recommandé). Même clé et même requête : la première réponse est renvoyée avec Idempotent-Replayed: true, sans nouvel envoi ni nouveau débit. Même clé pour une autre requête : 422 idempotency_key_reused. Requête identique encore en cours : 409 idempotency_in_progress.

Example:6f1c2b0e-8d4a-4f7e-9a51-3c2d1e0f9b87

Request body

valuesValues

Valeurs du formulaire, par clé de champ.

providerstring

Example request

{
  "provider": "free",
  "values": {
    "ref": "55443322",
    "motif": "Déménagement"
  },
  "sender": {
    "name": "Camille Martin",
    "street": "12 rue des Lilas",
    "city": "69003 Lyon"
  }
}

Response

Lettre rendue

letterstring required

providerstring nullable required

textstring required

completeboolean required

Example response

{
  "letter": "resiliation-box",
  "provider": "free",
  "doc": {
    "title": "Lettre de résiliation Free",
    "sender": [
      [
        {
          "text": "Camille Martin",
          "hole": false
        }
      ],
      [
        {
          "text": "12 rue des Lilas",
          "hole": false
        }
      ],
      [
        {
          "text": "69003 Lyon",
          "hole": false
        }
      ]
    ],
    "recipient": [
      [
        {
          "text": "Free",
          "hole": false
        }
      ],
      [
        {
          "text": "75371 Paris Cedex 08",
          "hole": false
        }
      ]
    ],
    "place": {
      "text": "Lyon",
      "hole": false
    },
    "date": {
      "text": "24 septembre 2026",
      "hole": false
    },
    "subject": [
      {
        "text": "Résiliation de mon abonnement Free",
        "hole": false
      }
    ],
    "body": [
      [
        {
          "text": "Madame, Monsieur,",
          "hole": false
        }
      ],
      [
        {
          "text": "Par la présente, je vous informe de ma décision de résilier mon abonnement internet Free, identifiant client ",
          "hole": false
        },
        {
          "text": "12345678",
          "hole": false
        },
        {
          "text": ".",
          "hole": false
        }
      ]
    ],
    "signature": {
      "text": "Camille Martin",
      "hole": false
    }
  },
  "plain": {
    "title": "Lettre de résiliation Free",
    "sender": [
      "Camille Martin",
      "12 rue des Lilas",
      "69003 Lyon"
    ],
    "recipient": [
      "Free",
      "75371 Paris Cedex 08"
    ],
    "place": "Lyon",
    "date": "24 septembre 2026",
    "subject": "Résiliation de mon abonnement Free",
    "body": [
      "Madame, Monsieur,",
      "Par la présente, je vous informe de ma décision de résilier mon abonnement internet Free, identifiant client 12345678."
    ],
    "signature": "Camille Martin"
  },
  "text": "Camille Martin\n12 rue des Lilas\n69003 Lyon\n\nFree\n75371 Paris Cedex 08\n\nLyon, le 24 septembre 2026\n\nObjet : Résiliation de mon abonnement Free\n\nMadame, Monsieur,\n\nPar la présente, je vous informe de ma décision de résilier mon abonnement internet Free, identifiant client 12345678.\n\nCamille Martin",
  "missing": [],
  "complete": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.