**Versions de l’API** · [V2 (Latest)](/integrations/v2/docs?lang=fr) · **V1**

> **Cette version de l’API est obsolète.** Utilisez la dernière version pour toute nouvelle intégration. [Voir la documentation actuelle](/integrations/v2/docs?lang=fr)

# Modèles d’email

OpenAPI 3.0.3 · API 1.0.0

```json
[
  {
    "url": "https://api.unisoft.world/integrations/v1",
    "description": "API"
  }
]
```

Modèles d’email HTML réutilisables (collection email_templates). CRUD complet. Envoyez un document email HTML COMPLET conforme aux règles de compatibilité client (voir EmailTemplateContentInput). L’identifiant d’un modèle peut être associé à une campagne comme email de remerciement au donateur (`campagnes.config.donorEmailTemplate`). Autorisations : `email_templates:read`/`email_templates:write`.

## Opérations

## GET /email-templates

Lister les modèles d’email

`list_email_templates`

Autorisation requise : `email_templates:read`. Liste les modèles d’email de l’organisation (champs succincts, sans html). Résultats paginés.

### Authentification

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Permissions requises

```json
{
  "accepted": "email_templates:read",
  "additional": []
}
```

### Paramètres

```json
{
  "name": "limit",
  "in": "query",
  "schema": {
    "type": "integer",
    "minimum": 1,
    "maximum": 200,
    "default": 50
  },
  "description": "Nombre de résultats par page."
}
```

```json
{
  "name": "cursor",
  "in": "query",
  "schema": {
    "type": "string"
  },
  "description": "Curseur opaque renvoyé par la requête précédente."
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EmailTemplate"
            }
          },
          "meta": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "ERREUR",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "ERROR"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "AUTORISATION_INSUFFISANTE",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "INSUFFICIENT_SCOPE"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "email_templates:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## POST /email-templates

Créer un modèle d’email

`create_email_template`

Autorisation requise : `email_templates:write`. Crée un modèle. `html` est facultatif (créez un modèle vide, puis remplissez-le via PUT /{id}/content). Après la création, associez son identifiant à une campagne comme email de remerciement au donateur (`campagnes.config.donorEmailTemplate`).

### Authentification

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Permissions requises

```json
{
  "accepted": "email_templates:write",
  "additional": []
}
```

### Corps de la requête

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EmailTemplateCreateInput"
      }
    }
  }
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "$ref": "#/components/schemas/EmailTemplate"
          }
        }
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "ERREUR_DE_VALIDATION",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "VALIDATION_ERROR"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "AUTORISATION_INSUFFISANTE",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "INSUFFICIENT_SCOPE"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "email_templates:write",
  "x-unisoft-mcp": {
    "category": "create",
    "readOnly": false,
    "destructive": false,
    "idempotent": false,
    "warn": false
  }
}
```

## GET /email-templates/{id}

Obtenir un modèle d’email

`get_email_template`

Autorisation requise : `email_templates:read`. Modèle complet, avec `html`, `design` et `assets`.

### Authentification

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Permissions requises

```json
{
  "accepted": "email_templates:read",
  "additional": []
}
```

### Paramètres

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid",
    "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
  },
  "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid."
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "$ref": "#/components/schemas/EmailTemplate"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "NOT_FOUND"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "email_templates:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## PATCH /email-templates/{id}

Renommer un modèle d’email

`update_email_template`

Autorisation requise : `email_templates:write`. Renomme le modèle (métadonnées uniquement ; utilisez PUT /{id}/content pour modifier le HTML).

### Authentification

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Permissions requises

```json
{
  "accepted": "email_templates:write",
  "additional": []
}
```

### Paramètres

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid",
    "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
  },
  "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid."
}
```

### Corps de la requête

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EmailTemplateRenameInput"
      }
    }
  }
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "ERREUR_DE_VALIDATION",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "VALIDATION_ERROR"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "NOT_FOUND"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "email_templates:write",
  "x-unisoft-mcp": {
    "category": "update",
    "readOnly": false,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## DELETE /email-templates/{id}

Supprimer un modèle d’email

`delete_email_template`

Autorisation requise : `email_templates:write`. Supprime logiquement le modèle.

### Authentification

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Permissions requises

```json
{
  "accepted": "email_templates:write",
  "additional": []
}
```

### Paramètres

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid",
    "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
  },
  "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid."
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "NOT_FOUND"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "email_templates:write",
  "x-unisoft-mcp": {
    "category": "delete",
    "readOnly": false,
    "destructive": true,
    "idempotent": true,
    "warn": false
  }
}
```

## PUT /email-templates/{id}/content

Définir le contenu HTML d’un modèle

`update_email_template_content`

Autorisation requise : `email_templates:write`. Définit le HTML du modèle (régénère l’aperçu, au mieux). Respectez les règles de compatibilité des clients de messagerie de EmailTemplateContentInput.

### Authentification

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### Permissions requises

```json
{
  "accepted": "email_templates:write",
  "additional": []
}
```

### Paramètres

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid",
    "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
  },
  "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid."
}
```

### Corps de la requête

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EmailTemplateContentInput"
      }
    }
  }
}
```

### Réponses

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "$ref": "#/components/schemas/EmailTemplate"
          }
        }
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "ERREUR_DE_VALIDATION",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "VALIDATION_ERROR"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "NOT_FOUND"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "email_templates:write",
  "x-unisoft-mcp": {
    "category": "update",
    "readOnly": false,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## Schémas

```json
{
  "components": {
    "parameters": {
      "LimitParam": {
        "name": "limit",
        "in": "query",
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 200,
          "default": 50
        },
        "description": "Nombre de résultats par page."
      },
      "CursorParam": {
        "name": "cursor",
        "in": "query",
        "schema": {
          "type": "string"
        },
        "description": "Curseur opaque renvoyé par la requête précédente."
      },
      "IdParam": {
        "name": "id",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
        },
        "description": "Identifiant de ressource — doit être un UUID. Un identifiant mal formé est refusé avec 400 INVALID_UUID (pas simplement 404). Besoin d’un nouvel identifiant ? Appelez GET /utils/uuid."
      }
    },
    "schemas": {
      "EmailTemplate": {
        "type": "object",
        "description": "Modèle HTML d’email réutilisable (collection email_templates). Email HTML complet réutilisable par une organisation — par ex. associé à une campagne comme email de remerciement au donateur (`campagnes.config.donorEmailTemplate`). `design`/`assets` sont les structures internes de l’éditeur (exposées en lecture seule).",
        "properties": {
          "id": {
            "type": "string"
          },
          "organisation": {
            "type": "string"
          },
          "name": {
            "type": "string",
            "description": "Nom d’affichage du modèle."
          },
          "editorType": {
            "type": "string",
            "enum": [
              "EDITOR",
              "AI"
            ],
            "description": "Éditeur utilisé : EDITOR (éditeur visuel, stocke `design`) ou AI (éditeur IA, stocke `assets`)."
          },
          "html": {
            "type": "string",
            "nullable": true,
            "description": "Email HTML complet."
          },
          "design": {
            "type": "object",
            "nullable": true,
            "readOnly": true,
            "description": "Sérialisation de l’éditeur visuel (lecture seule ; modèles EDITOR uniquement).",
            "additionalProperties": true
          },
          "assets": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "readOnly": true,
            "description": "Identifiants de ressources intégrés par l’éditeur IA (lecture seule)."
          },
          "thumbnailUrl": {
            "type": "string",
            "format": "uri",
            "nullable": true,
            "readOnly": true,
            "description": "URL publique de l’aperçu PNG généré automatiquement (au mieux ; null s’il n’a pas été généré)."
          },
          "datetime": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "editDatetime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "readOnly": true
          }
        }
      },
      "Pagination": {
        "type": "object",
        "properties": {
          "nextCursor": {
            "type": "string",
            "nullable": true
          },
          "hasMore": {
            "type": "boolean"
          },
          "count": {
            "type": "integer"
          }
        }
      },
      "EmailTemplateCreateInput": {
        "type": "object",
        "description": "Créer un modèle d’email. `html` est facultatif (vous pouvez créer un modèle vide, puis le remplir via PUT /{id}/content). S’il est fourni, respectez les règles de compatibilité des clients de messagerie décrites dans EmailTemplateContentInput.",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Nom d’affichage."
          },
          "editorType": {
            "type": "string",
            "enum": [
              "EDITOR",
              "AI"
            ],
            "default": "AI",
            "description": "AI par défaut."
          },
          "html": {
            "type": "string",
            "description": "Email HTML complet (voir les règles de EmailTemplateContentInput)."
          }
        }
      },
      "EmailTemplateRenameInput": {
        "type": "object",
        "description": "Renommer un modèle d’email (métadonnées uniquement ; ne modifie pas le HTML).",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string"
          }
        }
      },
      "EmailTemplateContentInput": {
        "type": "object",
        "description": "Email HTML complet d’un modèle. Contrairement à un bloc de contenu, il s’agit d’un DOCUMENT EMAIL HTML COMPLET (<!DOCTYPE html><html>…</html> attendu). Un aperçu PNG est généré automatiquement au mieux (peut être null).\n\nRÈGLES DE COMPATIBILITÉ CLIENTS EMAIL que le HTML DOIT respecter (identiques à celles de l’éditeur IA d’email intégré, puisqu’aucun éditeur ne peut les imposer ici) :\n• Mise en page avec <table>/<tr>/<td> UNIQUEMENT (pas de flexbox/grid — Outlook les ignore).\n• Styles INLINE uniquement — pas de bloc <style> externe, pas de classes CSS (Outlook les supprime).\n• Largeur maximale de 600px, centrée, arrière-plan de page neutre (#f4f4f4).\n• Polices : UNIQUEMENT Arial, Helvetica, sans-serif (les polices web ne sont pas prises en charge).\n• Images avec attributs HTML width/height EXPLICITES (pas seulement en CSS).\n• Pas de JavaScript ni de formulaires complexes ; couleurs de liens en ligne, pas de :hover.\n• Structure OBLIGATOIRE : en-tête (bande colorée avec logo/nom de l’organisation) + corps (zone blanche) + pied de page (mentions légales, lien de désinscription {{mailing_unsubscribe}} — OBLIGATOIRE — et coordonnées).\n• Variables disponibles pour l’interpolation : {{firstname}}, {{lastname}}, {{hebrewname}}, {{mailing_unsubscribe}} (alias historiques {{prenom}}, {{nom}}, {{prenomHE}} toujours pris en charge ; variables de l’organisation comme {{org.name}} également disponibles).\n• Cet email est destiné à une communauté JUIVE : n’introduisez JAMAIS de symbole/emoji d’une autre religion (✝️ ✝ ⛪ ☦️ ☪️ 🕌 🛕 ☸️ 🔯). Les symboles juifs (✡️ 🕎) et les emojis neutres conviennent.",
        "required": [
          "html"
        ],
        "properties": {
          "html": {
            "type": "string",
            "description": "Email HTML complet. Respectez les règles ci-dessus."
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "API Key",
        "description": "Format : `ke_live_xxx`"
      },
      "apiKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  }
}
```
