# API Templates : gérer vos modèles


Référence complète de l’API pour lister, récupérer, créer, modifier et supprimer des modèles dans PDFMonkey.

> [!TIP]
> **La plupart des utilisateurs n’ont pas besoin de l’API Modèles**
>
> Les modèles sont généralement conçus dans le [Dashboard](../generation-de-documents/utiliser-le-tableau-de-bord.md) ou le [Builder visuel](../modeles-builder/_index.md). L’API Modèles est utile lorsque vous gérez des modèles par programmation (par exemple, synchronisation depuis un pipeline CI ou construction d’un éditeur personnalisé). Pour générer des documents à partir d’un modèle existant, consultez l’[API Documents](./documents.md).


## Authentification

Toutes les requêtes nécessitent un token Bearer dans l’en-tête `Authorization` :

```
Authorization: Bearer YOUR_SECRET_KEY
```

Consultez [Authentification](./authentication.md) pour savoir comment trouver votre clé API.

## L’objet DocumentTemplate

Un DocumentTemplate est le design réutilisable qui définit la mise en page d’un document. Il contient :

- **HTML + Liquid** pour le contenu dynamique
- **CSS / SCSS** pour le style
- **Données de test** pour l’aperçu dans le Dashboard
- **Paramètres** pour le format du papier, les marges, les en-têtes et les pieds de page

### Propriétés brouillon et publiées {#draft-vs-published-properties}

Chaque modèle maintient deux ensembles de propriétés :

- Les propriétés **brouillon** (`body_draft`, `scss_style_draft`, `settings_draft`, `sample_data_draft`, `pdf_engine_draft_id`) pour le contenu en cours d’édition dans le Dashboard mais pas encore publié.
- Les propriétés **publiées** (`body`, `scss_style`, `settings`, `sample_data`, `pdf_engine_id`) utilisées lors de la génération des documents.

Lorsque vous publiez un modèle dans le Dashboard, les valeurs brouillon sont copiées vers leurs équivalents publiés.

### Attributs {#attributes}

```json5 title="Objet DocumentTemplate"
{
  id: "8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9",
  app_id: "3161c5e5-9966-4630-9b07-63f718092784",
  identifier: "Mon Super Modèle",
  edition_mode: "code",
  output_type: "pdf",
  body: "<p>Bonjour {{name}}</p>",
  body_draft: "<p>Bonjour, <strong>{{name}} !</strong></p>",
  scss_style: "p { color: green; }",
  scss_style_draft: "p { color: purple; }",
  sample_data: '{ "name": "Pierre Dupont" }',
  sample_data_draft: '{ "name": "Spider-Man" }',
  settings: {
    footer: {
      center: null,
      content: null,
      left: null,
      right: "page [page]/[topage]",
    },
    header: {
      center: null,
      content: null,
      left: null,
      right: null,
    },
    inject_javascript: false,
    margin: {
      bottom: 0,
      left: 0,
      right: 0,
      top: 0,
    },
    orientation: "portrait",
    paper_format: "a4",
    paper_height: 297,
    paper_width: 210,
    transparent_background: false,
    use_emojis: false,
    use_paged: false,
  },
  settings_draft: {
    /* même structure que settings */
  },
  pdf_engine_id: "5c709522-90db-4aea-b49f-15aeaa7180c7",
  pdf_engine_draft_id: "5c709522-90db-4aea-b49f-15aeaa7180c7",
  template_folder_id: null,
  ttl: 86400,
  created_at: "2050-01-02T03:04:05.678+02:00",
  updated_at: "2050-01-02T03:04:05.678+02:00",
  auth_token: "ZCsspcSZieyfdCUHYjKW1B9D8mnrz2ck",
  checksum: "kfYsx6xzMx3JkYxLd4LW6YeU5rkcuTxQ",
  preview_url: "https://preview.pdfmonkey.io/pdf/...",
}
```

| Attribut              | Type              | Description                                                                                                                                                                                                 |
| :-------------------- | :---------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                  | UUID              | Identifiant unique.                                                                                                                                                                                         |
| `app_id`              | UUID              | Identifiant unique de l’[espace de travail](../premiers-pas/_index.md) du modèle.                                                                                                                           |
| `identifier`          | String            | Nom lisible (1 à 100 caractères).                                                                                                                                                                           |
| `edition_mode`        | String            | `code`, `visual` (obsolète) ou `builder`.                                                                                                                                                                   |
| `output_type`         | String            | `pdf` ou `image`. Détermine le format des documents générés.                                                                                                                                                |
| `body`                | String            | Contenu HTML + Liquid publié, utilisé pour générer les documents.                                                                                                                                           |
| `body_draft`          | String            | Contenu HTML + Liquid non publié, pas encore utilisé pour la génération.                                                                                                                                    |
| `scss_style`          | String            | Styles CSS ou SCSS publiés, appliqués au contenu. Ne s’applique pas aux en-têtes ni aux pieds de page.                                                                                                      |
| `scss_style_draft`    | String            | Styles CSS ou SCSS non publiés.                                                                                                                                                                             |
| `sample_data`         | String            | Données de test publiées. Non utilisées pour la génération ; servent de point de restauration pour les modifications brouillon.                                                                             |
| `sample_data_draft`   | String            | Données JSON brouillon utilisées pour prévisualiser le modèle. Non utilisées pour la génération.                                                                                                            |
| `settings`            | Object            | Paramètres d’impression publiés. Voir [Paramètres](#settings) ci-dessous.                                                                                                                                   |
| `settings_draft`      | Object            | Paramètres d’impression non publiés. Voir [Paramètres](#settings) ci-dessous.                                                                                                                               |
| `pdf_engine_id`       | UUID              | ID du moteur PDF utilisé lors de la génération des documents. Voir [Moteurs PDF](#pdf-engines) ci-dessous.                                                                                                  |
| `pdf_engine_draft_id` | UUID              | ID du moteur PDF utilisé pour prévisualiser le contenu brouillon. Utile pour tester un nouveau moteur avant de basculer. Voir [Moteurs PDF](#pdf-engines) ci-dessous.                                       |
| `template_folder_id`  | UUID ou `null`    | ID d’un dossier pour regrouper le modèle.                                                                                                                                                                   |
| `ttl`                 | Number            | Durée de vie en secondes. Les documents générés depuis ce modèle sont automatiquement supprimés après ce délai. Voir [Rétention et suppression](../generation-de-documents/conservation-et-suppression.md). |
| `created_at`          | String (ISO 8601) | Date de création du modèle.                                                                                                                                                                                 |
| `updated_at`          | String (ISO 8601) | Date de dernière modification du modèle.                                                                                                                                                                    |
| `auth_token`          | String            | _Interne. Non utilisé._                                                                                                                                                                                     |
| `checksum`            | String            | Interne. Utilisé pour l’invalidation du cache d’aperçu.                                                                                                                                                     |
| `preview_url`         | String (URL)      | URL pour prévisualiser le modèle avec les propriétés brouillon. À intégrer dans un `<iframe>` ou à ouvrir directement.                                                                                      |

### Paramètres {#settings}

L’attribut `settings` (et son équivalent brouillon `settings_draft`) contrôle la mise en page, le formatage et le comportement des documents générés.

Tous les paramètres ne s’appliquent pas à chaque configuration de modèle. La colonne **S’applique à** indique les modes d’édition et types de sortie concernés par chaque paramètre.

| Attribut                                                        | Type    | S’applique à                                                                                                       | Description                                                                                                                                                                                                                     |
| :-------------------------------------------------------------- | :------ | :----------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `footer`                                                        | Object  | PDF (code, builder)                                                                                                | Configure le pied de page.                                                                                                                                                                                                      |
| `footer.left` / `footer.center` / `footer.right`                | String  | PDF (code, builder)                                                                                                | Contenu pour les parties gauche, centre ou droite du pied de page. Les tokens magiques `[page]` et `[topage]` insèrent le numéro de page courant et le nombre total de pages. HTML + Liquid non pris en charge.                 |
| `footer.content`                                                | String  | PDF (code, builder)                                                                                                | Contenu pleine largeur pour le pied de page. Remplace `left`, `center` et `right` lorsqu’il est défini.                                                                                                                         |
| `header`                                                        | Object  | PDF (code, builder)                                                                                                | Configure l’en-tête.                                                                                                                                                                                                            |
| `header.left` / `header.center` / `header.right`                | String  | PDF (code, builder)                                                                                                | Contenu pour les parties gauche, centre ou droite de l’en-tête. Les tokens magiques `[page]` et `[topage]` peuvent être utilisés. HTML + Liquid non pris en charge.                                                             |
| `header.content`                                                | String  | PDF (code, builder)                                                                                                | Contenu pleine largeur pour l’en-tête. Remplace `left`, `center` et `right` lorsqu’il est défini.                                                                                                                               |
| `inject_javascript`                                             | Boolean | Tous                                                                                                               | Lorsque `true`, le payload du document (ou les données de test) est accessible en JavaScript via la variable `$docPayload`. Peut impacter les performances avec de gros payloads. **Toujours activé pour les modèles builder.** |
| `margin`                                                        | Object  | PDF (code, builder)                                                                                                | Définit les marges du document.                                                                                                                                                                                                 |
| `margin.bottom` / `margin.left` / `margin.right` / `margin.top` | Number  | PDF (code, builder)                                                                                                | Marge en millimètres. Valeur par défaut : `10` si défini à `null` ou omis.                                                                                                                                                      |
| `orientation`                                                   | String  | PDF (code, builder)                                                                                                | Orientation de la page : `portrait` ou `landscape`.                                                                                                                                                                             |
| `paper_format`                                                  | String  | PDF (code, builder)                                                                                                | Format du papier : `a0`, `a1`, `a2`, `a3`, `a4`, `a5`, `a6`, `letter` ou `custom`.                                                                                                                                              |
| `paper_height`                                                  | Number  | PDF (code, builder)                                                                                                | Hauteur du papier en millimètres. Utilisé uniquement lorsque `paper_format` est `custom` ; sinon dérivé du format.                                                                                                              |
| `paper_width`                                                   | Number  | Largeur du papier en millimètres. Utilisé uniquement lorsque `paper_format` est `custom` ; sinon dérivé du format. |
| `transparent_background`                                        | Boolean | Image                                                                                                              | Lorsque `true`, l’image générée a un fond transparent au lieu de blanc.                                                                                                                                                         |
| `use_emojis`                                                    | Boolean | Tous                                                                                                               | Lorsque `true`, active le rendu des emojis (via [Noto Color Emoji](https://fonts.google.com/noto/specimen/Noto+Color+Emoji)) dans le document généré.                                                                           |
| `use_paged`                                                     | Boolean | PDF (code, builder)                                                                                                | Spécifique au [moteur PDF v3](../modeles-code/nos-moteurs.md). Lorsque `true`, le moteur attend que le rendu Paged.js soit terminé avant de générer le PDF. Les autres moteurs ignorent ce paramètre.                           |

### Moteurs PDF {#pdf-engines}

PDFMonkey propose plusieurs moteurs PDF, chacun avec des capacités différentes. **Nous recommandons fortement d’utiliser le v4**, le plus récent et le plus puissant. Consultez [Nos moteurs](../modeles-code/nos-moteurs.md) pour une comparaison détaillée.

Pour récupérer la liste des moteurs disponibles :

```bash title="Requête"
curl https://api.pdfmonkey.io/api/v1/engines \
  -H "Authorization: Bearer VOTRE_CLE_SECRETE"
```

```json5 title="Réponse"
{
  pdf_engines: [
    { id: "5c709522-90db-4aea-b49f-15aeaa7180c7", name: "v4", deprecated_on: null },
    { id: "61749ef7-6aca-4edb-84ca-685adb638c34", name: "v3", deprecated_on: null },
    { id: "1f8da2ab-29c4-455c-a5fb-8771e44148c3", name: "v2", deprecated_on: null },
  ],
  meta: {
    current_page: 1,
    next_page: null,
    prev_page: null,
    total_pages: 1,
  },
}
```

## Lister les modèles {#list-templates}

**`GET /api/v1/document_template_cards`**

Renvoie une liste paginée de fiches modèle. Les fiches modèle sont des objets légers qui omettent le corps, les styles et les données de test du modèle.

### Paramètres de requête {#query-parameters}

| Nom               | Type          | Requis  | Description                                                                                                                                       |
| :---------------- | :------------ | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------ |
| `q[workspace_id]` | String (UUID) | **Oui** | L’espace de travail dont lister les modèles. Accepte aussi `q[workspaceId]`, `q[app_id]` ou `q[appId]`.                                           |
| `q[folders]`      | String        | Non     | Liste d’IDs de dossiers séparés par des virgules. Utilisez `"none"` pour les modèles hors dossier, ou `"all"` (par défaut) pour tous les modèles. |
| `page`            | Integer       | Non     | Numéro de page pour la pagination.                                                                                                                |
| `sort`            | String        | Non     | Attribut de tri.                                                                                                                                  |

### Requête {#list-request}








**curl**

```bash
curl -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  'https://api.pdfmonkey.io/api/v1/document_template_cards?q[workspace_id]=3161c5e5-9966-4630-9b07-63f718092784'
```

**Ruby**

```ruby
cards = Pdfmonkey::Template.list_cards(
  workspace_id: '3161c5e5-9966-4630-9b07-63f718092784'
)

cards.each { |card| puts card.identifier }
```

**Node.js**

```javascript
const response = await fetch(
  "https://api.pdfmonkey.io/api/v1/document_template_cards?q[workspace_id]=3161c5e5-9966-4630-9b07-63f718092784",
  {
    headers: {
      Authorization: "Bearer YOUR_SECRET_KEY",
    },
  },
);

const data = await response.json();
console.log(data.document_template_cards);
```

**Python**

```python
import requests

response = requests.get(
    'https://api.pdfmonkey.io/api/v1/document_template_cards',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
    params={
        'q[workspace_id]': '3161c5e5-9966-4630-9b07-63f718092784',
    },
)

data = response.json()
print(data['document_template_cards'])
```

**PHP**

```php
<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/document_template_cards?q[workspace_id]=3161c5e5-9966-4630-9b07-63f718092784');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data['document_template_cards']);
```



### Réponse {#list-response}

```json title="200 OK"
{
  "document_template_cards": [
    {
      "id": "8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9",
      "app_id": "3161c5e5-9966-4630-9b07-63f718092784",
      "auth_token": "ZCsspcSZieyfdCUHYjKW1B9D8mnrz2ck",
      "created_at": "2050-01-02T03:04:05.678+02:00",
      "edition_mode": "code",
      "identifier": "Mon Super Modèle",
      "is_draft": true,
      "output_type": "pdf",
      "pdf_engine_deprecated_on": null,
      "pdf_engine_name": "v4",
      "template_folder_id": null,
      "template_folder_identifier": null,
      "updated_at": "2050-01-02T03:04:05.678+02:00"
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1
  }
}
```

> [!NOTE]
> **Fiches modèle et modèles complets**
>
> Les fiches modèle sont légères : elles incluent les métadonnées comme `identifier`, `edition_mode` et `is_draft`, mais **pas** le corps du modèle, les styles ni les données de test. Pour obtenir le contenu complet d’un modèle, utilisez [Récupérer un modèle](#get-a-template).


## Récupérer un modèle {#get-a-template}

**`GET /api/v1/document_templates/{id}`**

Renvoie l’[objet DocumentTemplate](#lobjet-documenttemplate) complet incluant le corps, les styles, les données de test et les paramètres.

### Requête {#get-request}








**curl**

```bash
curl -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9
```

**Ruby**

```ruby
template = Pdfmonkey::Template.fetch('8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9')

puts template.identifier
puts template.body
puts template.settings
```

**Node.js**

```javascript
const response = await fetch("https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9", {
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
  },
});

const data = await response.json();
console.log(data.document_template);
```

**Python**

```python
import requests

response = requests.get(
    'https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
)

data = response.json()
print(data['document_template'])
```

**PHP**

```php
<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data['document_template']);
```



### Réponse {#get-response}

Renvoie `200 OK` avec un objet `document_template` :

```json title="200 OK"
{
  "document_template": {
    "id": "8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9",
    "app_id": "3161c5e5-9966-4630-9b07-63f718092784",
    "identifier": "Mon Super Modèle",
    "edition_mode": "code",
    "output_type": "pdf",
    "body": "<p>Bonjour {{name}}</p>",
    "body_draft": "<p>Bonjour, <strong>{{name}} !</strong></p>",
    "scss_style": "p { color: green; }",
    "scss_style_draft": "p { color: purple; }",
    "sample_data": "{ \"name\": \"Pierre Dupont\" }",
    "sample_data_draft": "{ \"name\": \"Spider-Man\" }",
    "settings": { "...": "..." },
    "settings_draft": { "...": "..." },
    "pdf_engine_id": "5c709522-90db-4aea-b49f-15aeaa7180c7",
    "pdf_engine_draft_id": "5c709522-90db-4aea-b49f-15aeaa7180c7",
    "template_folder_id": null,
    "ttl": 86400,
    "created_at": "2050-01-02T03:04:05.678+02:00",
    "updated_at": "2050-01-02T03:04:05.678+02:00",
    "auth_token": "ZCsspcSZieyfdCUHYjKW1B9D8mnrz2ck",
    "checksum": "kfYsx6xzMx3JkYxLd4LW6YeU5rkcuTxQ",
    "preview_url": "https://preview.pdfmonkey.io/pdf/..."
  }
}
```

## Créer un modèle {#create-a-template}

**`POST /api/v1/document_templates`**

Crée un nouveau modèle. Dans la plupart des cas, il est préférable de créer les modèles via le [Dashboard](../generation-de-documents/utiliser-le-tableau-de-bord.md), mais l’API est disponible pour les workflows programmatiques.

### Paramètres {#create-parameters}

Tous les paramètres sont imbriqués sous une clé `document_template`.

| Nom                   | Type             | Requis  | Description                                                                                                                                                                                 |
| :-------------------- | :--------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `app_id`              | String (UUID)    | **Oui** | L’espace de travail dans lequel créer le modèle.                                                                                                                                            |
| `identifier`          | String           | **Oui** | Nom lisible (1 à 100 caractères).                                                                                                                                                           |
| `body`                | String           | Non     | Contenu HTML + Liquid publié.                                                                                                                                                               |
| `body_draft`          | String           | Non     | Contenu HTML + Liquid brouillon.                                                                                                                                                            |
| `scss_style`          | String           | Non     | Styles CSS/SCSS publiés.                                                                                                                                                                    |
| `scss_style_draft`    | String           | Non     | Styles CSS/SCSS brouillon.                                                                                                                                                                  |
| `sample_data`         | String           | Non     | Données de test publiées (chaîne JSON).                                                                                                                                                     |
| `sample_data_draft`   | String           | Non     | Données de test brouillon (chaîne JSON).                                                                                                                                                    |
| `settings`            | Object ou String | Non     | Paramètres d’impression publiés. Voir [Paramètres](#settings).                                                                                                                              |
| `settings_draft`      | Object ou String | Non     | Paramètres d’impression brouillon.                                                                                                                                                          |
| `pdf_engine_id`       | String (UUID)    | Non     | Moteur PDF pour la génération. Par défaut, le dernier moteur. Voir [Moteurs PDF](#pdf-engines).                                                                                             |
| `pdf_engine_draft_id` | String (UUID)    | Non     | Moteur PDF pour l’aperçu. Par défaut, le dernier moteur.                                                                                                                                    |
| `template_folder_id`  | String (UUID)    | Non     | Dossier dans lequel placer le modèle.                                                                                                                                                       |
| `ttl`                 | Integer          | Non     | Durée de vie en secondes des documents générés. Les valeurs autorisées dépendent de votre plan. Voir [Rétention et suppression](../generation-de-documents/conservation-et-suppression.md). |
| `edition_mode`        | String           | Non     | `code` (par défaut) ou `builder`.                                                                                                                                                           |
| `output_type`         | String           | Non     | `pdf` (par défaut) ou `image`. Voir [Format de sortie](../generation-de-documents/format-de-sortie.md).                                                                                     |

### Requête {#create-request}








**curl**

```bash
curl https://api.pdfmonkey.io/api/v1/document_templates \
  -X POST \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "document_template": {
      "app_id": "3161c5e5-9966-4630-9b07-63f718092784",
      "identifier": "Invoice Template",
      "body_draft": "<h1>Invoice #{{number}}</h1><p>Total: {{total}}</p>",
      "scss_style_draft": "h1 { color: #333; }",
      "sample_data_draft": "{ \"number\": \"INV-001\", \"total\": \"$123.50\" }",
      "settings_draft": {
        "paper_format": "a4",
        "orientation": "portrait",
        "margin": { "top": 20, "bottom": 20, "left": 15, "right": 15 }
      }
    }
  }'
```

**Ruby**

```ruby
template = Pdfmonkey::Template.create(
  workspace_id: '3161c5e5-9966-4630-9b07-63f718092784',
  identifier: 'Invoice Template',
  body: '<h1>Invoice #{{number}}</h1><p>Total: {{total}}</p>',
  scss_style: 'h1 { color: #333; }',
  sample_data: '{ "number": "INV-001", "total": "$123.50" }',
  settings: {
    paper_format: 'a4',
    orientation: 'portrait',
    margin: { top: 20, bottom: 20, left: 15, right: 15 },
  },
)

puts template.id
```

**Node.js**

```javascript
const response = await fetch("https://api.pdfmonkey.io/api/v1/document_templates", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    document_template: {
      app_id: "3161c5e5-9966-4630-9b07-63f718092784",
      identifier: "Invoice Template",
      body_draft: "<h1>Invoice #{{number}}</h1><p>Total: {{total}}</p>",
      scss_style_draft: "h1 { color: #333; }",
      sample_data_draft: '{ "number": "INV-001", "total": "$123.50" }',
      settings_draft: {
        paper_format: "a4",
        orientation: "portrait",
        margin: { top: 20, bottom: 20, left: 15, right: 15 },
      },
    },
  }),
});

const data = await response.json();
console.log(data.document_template);
```

**Python**

```python
import requests

response = requests.post(
    'https://api.pdfmonkey.io/api/v1/document_templates',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
    json={
        'document_template': {
            'app_id': '3161c5e5-9966-4630-9b07-63f718092784',
            'identifier': 'Invoice Template',
            'body_draft': '<h1>Invoice #{{number}}</h1><p>Total: {{total}}</p>',
            'scss_style_draft': 'h1 { color: #333; }',
            'sample_data_draft': '{ "number": "INV-001", "total": "$123.50" }',
            'settings_draft': {
                'paper_format': 'a4',
                'orientation': 'portrait',
                'margin': {'top': 20, 'bottom': 20, 'left': 15, 'right': 15},
            },
        },
    },
)

data = response.json()
print(data['document_template'])
```

**PHP**

```php
<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/document_templates');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'document_template' => [
            'app_id' => '3161c5e5-9966-4630-9b07-63f718092784',
            'identifier' => 'Invoice Template',
            'body_draft' => '<h1>Invoice #{{number}}</h1><p>Total: {{total}}</p>',
            'scss_style_draft' => 'h1 { color: #333; }',
            'sample_data_draft' => '{ "number": "INV-001", "total": "$123.50" }',
            'settings_draft' => [
                'paper_format' => 'a4',
                'orientation' => 'portrait',
                'margin' => ['top' => 20, 'bottom' => 20, 'left' => 15, 'right' => 15],
            ],
        ],
    ]),
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data['document_template']);
```



### Réponse {#create-response}

Renvoie `201 Created` avec l’objet `document_template` complet.

### Erreurs de validation {#validation-errors}

Si des champs requis sont manquants ou invalides, l’API renvoie `422 Unprocessable Entity` :

```json title="422 Unprocessable Entity"
{
  "errors": {
    "identifier": ["can't be blank"]
  }
}
```

## Modifier un modèle {#update-a-template}

**`PUT /api/v1/document_templates/{id}`**

Met à jour un modèle existant. Seuls les champs inclus dans le corps de la requête sont modifiés.

### Paramètres {#update-parameters}

Tous les paramètres sont imbriqués sous une clé `document_template`. Les mêmes champs que [Créer un modèle](#create-a-template) sont acceptés.

### Requête {#update-request}








**curl**

```bash
curl https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9 \
  -X PUT \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "document_template": {
      "body_draft": "<h1>Invoice #{{number}}</h1><p>Due: {{due_date}}</p><p>Total: {{total}}</p>",
      "sample_data_draft": "{ \"number\": \"INV-001\", \"due_date\": \"2050-04-01\", \"total\": \"$123.50\" }"
    }
  }'
```

**Ruby**

```ruby
template = Pdfmonkey::Template.fetch('8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9')

template.update!(
  body: '<h1>Invoice #{{number}}</h1><p>Due: {{due_date}}</p><p>Total: {{total}}</p>',
  sample_data: '{ "number": "INV-001", "due_date": "2050-04-01", "total": "$123.50" }',
)
```

**Node.js**

```javascript
const response = await fetch("https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9", {
  method: "PUT",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    document_template: {
      body_draft: "<h1>Invoice #{{number}}</h1><p>Due: {{due_date}}</p><p>Total: {{total}}</p>",
      sample_data_draft: '{ "number": "INV-001", "due_date": "2050-04-01", "total": "$123.50" }',
    },
  }),
});

const data = await response.json();
console.log(data.document_template);
```

**Python**

```python
import requests

response = requests.put(
    'https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
    json={
        'document_template': {
            'body_draft': '<h1>Invoice #{{number}}</h1><p>Due: {{due_date}}</p><p>Total: {{total}}</p>',
            'sample_data_draft': '{ "number": "INV-001", "due_date": "2050-04-01", "total": "$123.50" }',
        },
    },
)

data = response.json()
print(data['document_template'])
```

**PHP**

```php
<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'document_template' => [
            'body_draft' => '<h1>Invoice #{{number}}</h1><p>Due: {{due_date}}</p><p>Total: {{total}}</p>',
            'sample_data_draft' => '{ "number": "INV-001", "due_date": "2050-04-01", "total": "$123.50" }',
        ],
    ]),
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data['document_template']);
```



### Réponse {#update-response}

Renvoie `200 OK` avec l’objet `document_template` mis à jour.

## Supprimer un modèle {#delete-a-template}

**`DELETE /api/v1/document_templates/{id}`**

Supprime définitivement un modèle.

> [!CAUTION]
> La suppression d’un modèle est irréversible. Tous les documents liés à ce modèle perdront leur référence de modèle.


### Requête {#delete-request}








**curl**

```bash
curl https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9 \
  -X DELETE \
  -H 'Authorization: Bearer YOUR_SECRET_KEY'
```

**Ruby**

```ruby
Pdfmonkey::Template.delete('8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9')
```

**Node.js**

```javascript
const response = await fetch("https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
  },
});

console.log(response.status); // => 204
```

**Python**

```python
import requests

response = requests.delete(
    'https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9',
    headers={
        'Authorization': 'Bearer YOUR_SECRET_KEY',
    },
)

print(response.status_code)  # => 204
```

**PHP**

```php
<?php
$ch = curl_init('https://api.pdfmonkey.io/api/v1/document_templates/8ac0d8f7-dbd3-46dd-b2d3-af036a2776d9');

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_SECRET_KEY',
    ],
]);

curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE); // => 204
curl_close($ch);
```



### Réponse {#delete-response}

Renvoie `204 No Content` avec un corps vide.

## Pages associées {#related-pages}

- **[Authentification](./authentication.md)** — Trouvez votre clé API et authentifiez vos requêtes.
- **[API Documents](./documents.md)** — Créez, listez et gérez les documents générés.
- **[Générer des documents via l’API](../generation-de-documents/generation-pdf-via-api.md)** — Guide pas à pas avec des exemples dans plusieurs langages.
- **[Nos moteurs](../modeles-code/nos-moteurs.md)** — Comparaison détaillée des versions de moteurs PDF.
- **[Format de sortie](../generation-de-documents/format-de-sortie.md)** — Choisir entre le format PDF et image.
- **[Rétention et suppression](../generation-de-documents/conservation-et-suppression.md)** — Comprendre les valeurs TTL et le nettoyage automatique des documents.
- **[Webhooks](../generation-de-documents/webhooks.md)** — Recevez des notifications lorsque la génération des documents est terminée.


## FAQ

**Qu’est-ce qu’un DocumentTemplate dans PDFMonkey ?**

Un DocumentTemplate est le design réutilisable qui définit la mise en page d’un document. Il contient du HTML + Liquid pour le contenu dynamique, du CSS/SCSS pour le style, des données de test pour la prévisualisation et des paramètres de format papier, marges, en-têtes et pieds de page.

**Comment lister tous les modèles avec l’API PDFMonkey ?**

Envoyez une requête GET à /api/v1/document_template_cards avec un paramètre q[workspace_id]. La réponse renvoie une liste paginée d’objets template card légers.

**Peut-on créer et modifier des modèles via l’API ?**

Oui. Envoyez un POST à /api/v1/document_templates pour créer un modèle et un PUT à /api/v1/document_templates/{id} pour le modifier. La plupart des utilisateurs conçoivent les modèles dans le Dashboard.
