cURL
curl --request POST \
--url https://api.example.com/public/emails \
--header 'Content-Type: application/json' \
--data '
{
"email_type": "<string>",
"origin": "<string>",
"email_timestamp": "2023-11-07T05:31:56Z",
"contact_email": "jsmith@example.com",
"contact_id": 123,
"agent_email": "jsmith@example.com",
"subject": "<string>",
"body_text": "<string>",
"body_html": "<string>",
"campaign_id": "<string>",
"campaign_name": "<string>",
"interested": true,
"custom_fields": [
{
"field_name": "<string>",
"field_value": "<string>"
}
]
}
'import requests
url = "https://api.example.com/public/emails"
payload = {
"email_type": "<string>",
"origin": "<string>",
"email_timestamp": "2023-11-07T05:31:56Z",
"contact_email": "jsmith@example.com",
"contact_id": 123,
"agent_email": "jsmith@example.com",
"subject": "<string>",
"body_text": "<string>",
"body_html": "<string>",
"campaign_id": "<string>",
"campaign_name": "<string>",
"interested": True,
"custom_fields": [
{
"field_name": "<string>",
"field_value": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
email_type: '<string>',
origin: '<string>',
email_timestamp: '2023-11-07T05:31:56Z',
contact_email: 'jsmith@example.com',
contact_id: 123,
agent_email: 'jsmith@example.com',
subject: '<string>',
body_text: '<string>',
body_html: '<string>',
campaign_id: '<string>',
campaign_name: '<string>',
interested: true,
custom_fields: [{field_name: '<string>', field_value: '<string>'}]
})
};
fetch('https://api.example.com/public/emails', 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://api.example.com/public/emails",
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([
'email_type' => '<string>',
'origin' => '<string>',
'email_timestamp' => '2023-11-07T05:31:56Z',
'contact_email' => 'jsmith@example.com',
'contact_id' => 123,
'agent_email' => 'jsmith@example.com',
'subject' => '<string>',
'body_text' => '<string>',
'body_html' => '<string>',
'campaign_id' => '<string>',
'campaign_name' => '<string>',
'interested' => true,
'custom_fields' => [
[
'field_name' => '<string>',
'field_value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/public/emails"
payload := strings.NewReader("{\n \"email_type\": \"<string>\",\n \"origin\": \"<string>\",\n \"email_timestamp\": \"2023-11-07T05:31:56Z\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_id\": 123,\n \"agent_email\": \"jsmith@example.com\",\n \"subject\": \"<string>\",\n \"body_text\": \"<string>\",\n \"body_html\": \"<string>\",\n \"campaign_id\": \"<string>\",\n \"campaign_name\": \"<string>\",\n \"interested\": true,\n \"custom_fields\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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))
}HttpResponse<String> response = Unirest.post("https://api.example.com/public/emails")
.header("Content-Type", "application/json")
.body("{\n \"email_type\": \"<string>\",\n \"origin\": \"<string>\",\n \"email_timestamp\": \"2023-11-07T05:31:56Z\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_id\": 123,\n \"agent_email\": \"jsmith@example.com\",\n \"subject\": \"<string>\",\n \"body_text\": \"<string>\",\n \"body_html\": \"<string>\",\n \"campaign_id\": \"<string>\",\n \"campaign_name\": \"<string>\",\n \"interested\": true,\n \"custom_fields\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/public/emails")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email_type\": \"<string>\",\n \"origin\": \"<string>\",\n \"email_timestamp\": \"2023-11-07T05:31:56Z\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_id\": 123,\n \"agent_email\": \"jsmith@example.com\",\n \"subject\": \"<string>\",\n \"body_text\": \"<string>\",\n \"body_html\": \"<string>\",\n \"campaign_id\": \"<string>\",\n \"campaign_name\": \"<string>\",\n \"interested\": true,\n \"custom_fields\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"updated_time": "2023-11-07T05:31:56Z",
"email_type": "<string>",
"origin": "<string>",
"email_timestamp": "2023-11-07T05:31:56Z",
"contact_email": "jsmith@example.com",
"contact_id": 123,
"agent_email": "jsmith@example.com",
"subject": "<string>",
"body_text": "<string>",
"body_html": "<string>",
"campaign_id": "<string>",
"campaign_name": "<string>",
"interested": true,
"custom_fields": [
{
"id": 123,
"updated_time": "2023-11-07T05:31:56Z",
"field_name": "<string>",
"field_value": "<string>"
}
]
}Emails
Create Email
Creates a new email in the system with the provided details.
POST
/
public
/
emails
cURL
curl --request POST \
--url https://api.example.com/public/emails \
--header 'Content-Type: application/json' \
--data '
{
"email_type": "<string>",
"origin": "<string>",
"email_timestamp": "2023-11-07T05:31:56Z",
"contact_email": "jsmith@example.com",
"contact_id": 123,
"agent_email": "jsmith@example.com",
"subject": "<string>",
"body_text": "<string>",
"body_html": "<string>",
"campaign_id": "<string>",
"campaign_name": "<string>",
"interested": true,
"custom_fields": [
{
"field_name": "<string>",
"field_value": "<string>"
}
]
}
'import requests
url = "https://api.example.com/public/emails"
payload = {
"email_type": "<string>",
"origin": "<string>",
"email_timestamp": "2023-11-07T05:31:56Z",
"contact_email": "jsmith@example.com",
"contact_id": 123,
"agent_email": "jsmith@example.com",
"subject": "<string>",
"body_text": "<string>",
"body_html": "<string>",
"campaign_id": "<string>",
"campaign_name": "<string>",
"interested": True,
"custom_fields": [
{
"field_name": "<string>",
"field_value": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
email_type: '<string>',
origin: '<string>',
email_timestamp: '2023-11-07T05:31:56Z',
contact_email: 'jsmith@example.com',
contact_id: 123,
agent_email: 'jsmith@example.com',
subject: '<string>',
body_text: '<string>',
body_html: '<string>',
campaign_id: '<string>',
campaign_name: '<string>',
interested: true,
custom_fields: [{field_name: '<string>', field_value: '<string>'}]
})
};
fetch('https://api.example.com/public/emails', 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://api.example.com/public/emails",
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([
'email_type' => '<string>',
'origin' => '<string>',
'email_timestamp' => '2023-11-07T05:31:56Z',
'contact_email' => 'jsmith@example.com',
'contact_id' => 123,
'agent_email' => 'jsmith@example.com',
'subject' => '<string>',
'body_text' => '<string>',
'body_html' => '<string>',
'campaign_id' => '<string>',
'campaign_name' => '<string>',
'interested' => true,
'custom_fields' => [
[
'field_name' => '<string>',
'field_value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/public/emails"
payload := strings.NewReader("{\n \"email_type\": \"<string>\",\n \"origin\": \"<string>\",\n \"email_timestamp\": \"2023-11-07T05:31:56Z\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_id\": 123,\n \"agent_email\": \"jsmith@example.com\",\n \"subject\": \"<string>\",\n \"body_text\": \"<string>\",\n \"body_html\": \"<string>\",\n \"campaign_id\": \"<string>\",\n \"campaign_name\": \"<string>\",\n \"interested\": true,\n \"custom_fields\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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))
}HttpResponse<String> response = Unirest.post("https://api.example.com/public/emails")
.header("Content-Type", "application/json")
.body("{\n \"email_type\": \"<string>\",\n \"origin\": \"<string>\",\n \"email_timestamp\": \"2023-11-07T05:31:56Z\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_id\": 123,\n \"agent_email\": \"jsmith@example.com\",\n \"subject\": \"<string>\",\n \"body_text\": \"<string>\",\n \"body_html\": \"<string>\",\n \"campaign_id\": \"<string>\",\n \"campaign_name\": \"<string>\",\n \"interested\": true,\n \"custom_fields\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/public/emails")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email_type\": \"<string>\",\n \"origin\": \"<string>\",\n \"email_timestamp\": \"2023-11-07T05:31:56Z\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_id\": 123,\n \"agent_email\": \"jsmith@example.com\",\n \"subject\": \"<string>\",\n \"body_text\": \"<string>\",\n \"body_html\": \"<string>\",\n \"campaign_id\": \"<string>\",\n \"campaign_name\": \"<string>\",\n \"interested\": true,\n \"custom_fields\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"updated_time": "2023-11-07T05:31:56Z",
"email_type": "<string>",
"origin": "<string>",
"email_timestamp": "2023-11-07T05:31:56Z",
"contact_email": "jsmith@example.com",
"contact_id": 123,
"agent_email": "jsmith@example.com",
"subject": "<string>",
"body_text": "<string>",
"body_html": "<string>",
"campaign_id": "<string>",
"campaign_name": "<string>",
"interested": true,
"custom_fields": [
{
"id": 123,
"updated_time": "2023-11-07T05:31:56Z",
"field_name": "<string>",
"field_value": "<string>"
}
]
}Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Response
Created. The email was successfully created.
Show child attributes
Show child attributes
Was this page helpful?