Create New Contact
curl --request POST \
--url https://api-prod.interactly.ai/campaigns/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"dob": "<string>",
"notification_preferences": {
"call": {
"enabled": true,
"dnd": [
{
"sourceId": "<string>",
"enabled": true,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
},
"sms": {
"enabled": true,
"dnd": [
{
"sourceId": "<string>",
"enabled": true,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
},
"email": {
"enabled": true,
"dnd": [
{
"sourceId": "<string>",
"enabled": true,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
}
}
}
'import requests
url = "https://api-prod.interactly.ai/campaigns/v1/contacts"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"dob": "<string>",
"notification_preferences": {
"call": {
"enabled": True,
"dnd": [
{
"sourceId": "<string>",
"enabled": True,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
},
"sms": {
"enabled": True,
"dnd": [
{
"sourceId": "<string>",
"enabled": True,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
},
"email": {
"enabled": True,
"dnd": [
{
"sourceId": "<string>",
"enabled": True,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
phone_number: '<string>',
email: '<string>',
dob: '<string>',
notification_preferences: {
call: {
enabled: true,
dnd: [
{
sourceId: '<string>',
enabled: true,
sourceName: '<string>',
reason: '<string>',
until: '2023-11-07T05:31:56Z'
}
]
},
sms: {
enabled: true,
dnd: [
{
sourceId: '<string>',
enabled: true,
sourceName: '<string>',
reason: '<string>',
until: '2023-11-07T05:31:56Z'
}
]
},
email: {
enabled: true,
dnd: [
{
sourceId: '<string>',
enabled: true,
sourceName: '<string>',
reason: '<string>',
until: '2023-11-07T05:31:56Z'
}
]
}
}
})
};
fetch('https://api-prod.interactly.ai/campaigns/v1/contacts', 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-prod.interactly.ai/campaigns/v1/contacts",
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([
'first_name' => '<string>',
'last_name' => '<string>',
'phone_number' => '<string>',
'email' => '<string>',
'dob' => '<string>',
'notification_preferences' => [
'call' => [
'enabled' => true,
'dnd' => [
[
'sourceId' => '<string>',
'enabled' => true,
'sourceName' => '<string>',
'reason' => '<string>',
'until' => '2023-11-07T05:31:56Z'
]
]
],
'sms' => [
'enabled' => true,
'dnd' => [
[
'sourceId' => '<string>',
'enabled' => true,
'sourceName' => '<string>',
'reason' => '<string>',
'until' => '2023-11-07T05:31:56Z'
]
]
],
'email' => [
'enabled' => true,
'dnd' => [
[
'sourceId' => '<string>',
'enabled' => true,
'sourceName' => '<string>',
'reason' => '<string>',
'until' => '2023-11-07T05:31:56Z'
]
]
]
]
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-prod.interactly.ai/campaigns/v1/contacts"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"dob\": \"<string>\",\n \"notification_preferences\": {\n \"call\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"sms\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"email\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <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))
}HttpResponse<String> response = Unirest.post("https://api-prod.interactly.ai/campaigns/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"dob\": \"<string>\",\n \"notification_preferences\": {\n \"call\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"sms\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"email\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.interactly.ai/campaigns/v1/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"dob\": \"<string>\",\n \"notification_preferences\": {\n \"call\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"sms\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"email\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Contacts
Create New Contact
Create a new contact for the team.
- body: The contact data including first_name, last_name, phone_number, and optional email and dob.
POST
/
campaigns
/
v1
/
contacts
Create New Contact
curl --request POST \
--url https://api-prod.interactly.ai/campaigns/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"dob": "<string>",
"notification_preferences": {
"call": {
"enabled": true,
"dnd": [
{
"sourceId": "<string>",
"enabled": true,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
},
"sms": {
"enabled": true,
"dnd": [
{
"sourceId": "<string>",
"enabled": true,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
},
"email": {
"enabled": true,
"dnd": [
{
"sourceId": "<string>",
"enabled": true,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
}
}
}
'import requests
url = "https://api-prod.interactly.ai/campaigns/v1/contacts"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"phone_number": "<string>",
"email": "<string>",
"dob": "<string>",
"notification_preferences": {
"call": {
"enabled": True,
"dnd": [
{
"sourceId": "<string>",
"enabled": True,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
},
"sms": {
"enabled": True,
"dnd": [
{
"sourceId": "<string>",
"enabled": True,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
},
"email": {
"enabled": True,
"dnd": [
{
"sourceId": "<string>",
"enabled": True,
"sourceName": "<string>",
"reason": "<string>",
"until": "2023-11-07T05:31:56Z"
}
]
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
phone_number: '<string>',
email: '<string>',
dob: '<string>',
notification_preferences: {
call: {
enabled: true,
dnd: [
{
sourceId: '<string>',
enabled: true,
sourceName: '<string>',
reason: '<string>',
until: '2023-11-07T05:31:56Z'
}
]
},
sms: {
enabled: true,
dnd: [
{
sourceId: '<string>',
enabled: true,
sourceName: '<string>',
reason: '<string>',
until: '2023-11-07T05:31:56Z'
}
]
},
email: {
enabled: true,
dnd: [
{
sourceId: '<string>',
enabled: true,
sourceName: '<string>',
reason: '<string>',
until: '2023-11-07T05:31:56Z'
}
]
}
}
})
};
fetch('https://api-prod.interactly.ai/campaigns/v1/contacts', 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-prod.interactly.ai/campaigns/v1/contacts",
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([
'first_name' => '<string>',
'last_name' => '<string>',
'phone_number' => '<string>',
'email' => '<string>',
'dob' => '<string>',
'notification_preferences' => [
'call' => [
'enabled' => true,
'dnd' => [
[
'sourceId' => '<string>',
'enabled' => true,
'sourceName' => '<string>',
'reason' => '<string>',
'until' => '2023-11-07T05:31:56Z'
]
]
],
'sms' => [
'enabled' => true,
'dnd' => [
[
'sourceId' => '<string>',
'enabled' => true,
'sourceName' => '<string>',
'reason' => '<string>',
'until' => '2023-11-07T05:31:56Z'
]
]
],
'email' => [
'enabled' => true,
'dnd' => [
[
'sourceId' => '<string>',
'enabled' => true,
'sourceName' => '<string>',
'reason' => '<string>',
'until' => '2023-11-07T05:31:56Z'
]
]
]
]
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-prod.interactly.ai/campaigns/v1/contacts"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"dob\": \"<string>\",\n \"notification_preferences\": {\n \"call\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"sms\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"email\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <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))
}HttpResponse<String> response = Unirest.post("https://api-prod.interactly.ai/campaigns/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"dob\": \"<string>\",\n \"notification_preferences\": {\n \"call\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"sms\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"email\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.interactly.ai/campaigns/v1/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"dob\": \"<string>\",\n \"notification_preferences\": {\n \"call\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"sms\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n },\n \"email\": {\n \"enabled\": true,\n \"dnd\": [\n {\n \"sourceId\": \"<string>\",\n \"enabled\": true,\n \"sourceName\": \"<string>\",\n \"reason\": \"<string>\",\n \"until\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Retrieve your API Key from Dashboard API Keys Section.
Body
application/json
Contact data
Contact's first name
Contact's last name
Contact's phone number
Contact's email address
Contact's date of birth in YYYY-MM-DD format
Notification preferences for the contact
Show child attributes
Show child attributes
Response
Successful Response
⌘I