Send a transactional e-mail

curl --request POST \
  --url https://{host}/api/v1/transactional-mails/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template": "confirmation-commande",
  "to": [
    "ada@example.com"
  ],
  "locale": "fr",
  "variables": {
    "customer": {
      "name": "Ada"
    },
    "order": {
      "number": "A-1024",
      "lines": [
        "Pain au levain",
        "Brioche"
      ]
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    template: 'confirmation-commande',
    to: ['ada@example.com'],
    locale: 'fr',
    variables: {
      customer: {name: 'Ada'},
      order: {number: 'A-1024', lines: ['Pain au levain', 'Brioche']}
    }
  })
};

fetch('https://{host}/api/v1/transactional-mails/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/v1/transactional-mails/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'template' => 'confirmation-commande',
    'to' => [
        'ada@example.com'
    ],
    'locale' => 'fr',
    'variables' => [
        'customer' => [
                'name' => 'Ada'
        ],
        'order' => [
                'number' => 'A-1024',
                'lines' => [
                                'Pain au levain',
                                'Brioche'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "https://{host}/api/v1/transactional-mails/send"

payload = {
    "template": "confirmation-commande",
    "to": ["ada@example.com"],
    "locale": "fr",
    "variables": {
        "customer": { "name": "Ada" },
        "order": {
            "number": "A-1024",
            "lines": ["Pain au levain", "Brioche"]
        }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template": "<string>",
    "subject": "<string>",
    "from": "jsmith@example.com",
    "to": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "bcc": [
      "jsmith@example.com"
    ],
    "status": "pending",
    "failure_reason": "<string>",
    "opens": 123,
    "clicks": 123,
    "sent_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "Unauthenticated."
}

{
  "message": "<string>"
}

{
  "message": "The email field must be a valid email address.",
  "errors": {}
}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "template": "<string>",
    "subject": "<string>",
    "from": "jsmith@example.com",
    "to": [
      "jsmith@example.com"
    ],
    "cc": [
      "jsmith@example.com"
    ],
    "bcc": [
      "jsmith@example.com"
    ],
    "status": "pending",
    "failure_reason": "<string>",
    "opens": 123,
    "clicks": 123,
    "sent_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}