Consulter un template d’email

GET /api/email/templates/(string: name)

Renvoie le template d’email demandé.

Request Headers:
Status Codes:
  • 200 OK – Le template a été renvoyé avec succès

  • 401 Unauthorized – Authentification REST invalide

  • 403 Forbidden – L’utilisateur REST n’a pas le droit d’effectuer cette action

  • 404 Not Found – Le template demandé n’existe pas

Response JSON Object:
  • name (string) – Le nom du template.

  • subject (string) – Le sujet de l’email.

  • mimeType (string) – Le type MIME du corps de l’email.

  • body (string) – Le corps de l’email.

  • attachments (array) – La liste des fichiers joints au template.


Exemple de requête

GET https://my_waarp_gateway.net/api/email/templates/transfer-error HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 142

{
  "name": "transfer-error",
  "subject": "Erreur de transfert",
  "mimeType": "text/plain",
  "body": "Le transfert {{ .Rule }} a échoué.",
  "attachments": []
}