Post v1transactional email templatesend - Terminal 3 Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

cURL

curl --request POST \
  --url https://staging.terminal3.io/v1/transactional_email_template/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <x-api-token>' \
  --data '
{
  "transactional_email_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": 1,
  "placeholders": {}
}
'

Python

import requests

url = "https://staging.terminal3.io/v1/transactional_email_template/send"

payload = {
    "transactional_email_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": 1,
    "placeholders": {}
}
headers = {
    "x-api-token": "<x-api-token>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript

const options = {
  method: 'POST',
  headers: {'x-api-token': '<x-api-token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    transactional_email_template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    user_id: 1,
    placeholders: {}
  })
};

fetch('https://staging.terminal3.io/v1/transactional_email_template/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.terminal3.io/v1/transactional_email_template/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([
    'transactional_email_template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'user_id' => 1,
    'placeholders' => [

]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-token: <x-api-token>"
  ],
]);

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

curl_close($curl);

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

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://staging.terminal3.io/v1/transactional_email_template/send"

payload := strings.NewReader("{\n  \"transactional_email_template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"user_id\": 1,\n  \"placeholders\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-token", "<x-api-token>")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Java

HttpResponse<String> response = Unirest.post("https://staging.terminal3.io/v1/transactional_email_template/send")
  .header("x-api-token", "<x-api-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"transactional_email_template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"user_id\": 1,\n  \"placeholders\": {}\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://staging.terminal3.io/v1/transactional_email_template/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-token"] = '<x-api-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"transactional_email_template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"user_id\": 1,\n  \"placeholders\": {}\n}"

response = http.request(request)
puts response.read_body

Response Codes

Error Response

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Headers

Body Structure