Post v1transactional email template - 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 \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <x-api-token>' \
  --data '\n{\n  "name": "<string>",\n  "subject": "<string>",\n  "body": "<string>"\n}'

Python

import requests

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

payload = {
    "name": "<string>",
    "subject": "<string>",
    "body": "<string>"
}
headers = {
    "x-api-token": "<x-api-token>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript (Fetch API)

const options = {
  method: 'POST',
  headers: {'x-api-token': '<x-api-token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', subject: '<string>', body: JSON.stringify('<string>')})
};

fetch('https://staging.terminal3.io/v1/transactional_email_template', 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",\
  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([\
    'name' => '<string>',\
    'subject' => '<string>',\
    'body' => '<string>'\
  ]),\
  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"

payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\"}\")

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 (Unirest)

HttpResponse<String> response = Unirest.post("https://staging.terminal3.io/v1/transactional_email_template")
  .header("x-api-token", "<x-api-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\"}\")
  .asString();

Ruby

require 'uri'
require 'net/http'

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

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  \"name\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\"}\"

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

Response Codes

• 200: Success
• 400: Bad Request
• 401: Unauthorized
• 403: Forbidden
• 422: Unprocessable Entity

Sample Response Objects

Successful response:

{
  "data": {
    "client_transactional_email_template_id": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Error response:

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

Headers

• x-api-token: string (required)
• x-api-subclient-id: string (optional)

Request Body

• name: string (required, minimum length: 1)
• subject: string (required, minimum length: 1)
• body: string (required, minimum length: 1)

Success Response

Returns successful information in JSON format.