Create Campaign with Email Touchpoint
curl --request POST \
--url https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "<string>",
"company_plan_id": "<string>",
"workspace_id": "<string>",
"business_goal": "<string>",
"touchpoint": {
"name": "<string>",
"type": "<string>",
"status": "<string>",
"start_at": "<string>",
"assistant_id": 123,
"customer_details": [
{
"id": "<string>",
"email": "<string>"
}
],
"additional_settings": {
"execution_days": [
"<string>"
],
"start_hour": 123,
"end_hour": 123,
"time_zone": "<string>",
"email": "<string>",
"from_emails": [
"<string>"
],
"email_medium": "<string>"
},
"email_subject": "<string>",
"email_body": "<string>",
"variables": "<string>"
}
}
'import requests
url = "https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint"
payload = {
"name": "<string>",
"type": "<string>",
"company_plan_id": "<string>",
"workspace_id": "<string>",
"business_goal": "<string>",
"touchpoint": {
"name": "<string>",
"type": "<string>",
"status": "<string>",
"start_at": "<string>",
"assistant_id": 123,
"customer_details": [
{
"id": "<string>",
"email": "<string>"
}
],
"additional_settings": {
"execution_days": ["<string>"],
"start_hour": 123,
"end_hour": 123,
"time_zone": "<string>",
"email": "<string>",
"from_emails": ["<string>"],
"email_medium": "<string>"
},
"email_subject": "<string>",
"email_body": "<string>",
"variables": "<string>"
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: '<string>',
company_plan_id: '<string>',
workspace_id: '<string>',
business_goal: '<string>',
touchpoint: {
name: '<string>',
type: '<string>',
status: '<string>',
start_at: '<string>',
assistant_id: 123,
customer_details: [{id: '<string>', email: '<string>'}],
additional_settings: {
execution_days: ['<string>'],
start_hour: 123,
end_hour: 123,
time_zone: '<string>',
email: '<string>',
from_emails: ['<string>'],
email_medium: '<string>'
},
email_subject: '<string>',
email_body: '<string>',
variables: '<string>'
}
})
};
fetch('https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint', 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://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint",
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>',
'type' => '<string>',
'company_plan_id' => '<string>',
'workspace_id' => '<string>',
'business_goal' => '<string>',
'touchpoint' => [
'name' => '<string>',
'type' => '<string>',
'status' => '<string>',
'start_at' => '<string>',
'assistant_id' => 123,
'customer_details' => [
[
'id' => '<string>',
'email' => '<string>'
]
],
'additional_settings' => [
'execution_days' => [
'<string>'
],
'start_hour' => 123,
'end_hour' => 123,
'time_zone' => '<string>',
'email' => '<string>',
'from_emails' => [
'<string>'
],
'email_medium' => '<string>'
],
'email_subject' => '<string>',
'email_body' => '<string>',
'variables' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"company_plan_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"business_goal\": \"<string>\",\n \"touchpoint\": {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"start_at\": \"<string>\",\n \"assistant_id\": 123,\n \"customer_details\": [\n {\n \"id\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"additional_settings\": {\n \"execution_days\": [\n \"<string>\"\n ],\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"time_zone\": \"<string>\",\n \"email\": \"<string>\",\n \"from_emails\": [\n \"<string>\"\n ],\n \"email_medium\": \"<string>\"\n },\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"variables\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"company_plan_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"business_goal\": \"<string>\",\n \"touchpoint\": {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"start_at\": \"<string>\",\n \"assistant_id\": 123,\n \"customer_details\": [\n {\n \"id\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"additional_settings\": {\n \"execution_days\": [\n \"<string>\"\n ],\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"time_zone\": \"<string>\",\n \"email\": \"<string>\",\n \"from_emails\": [\n \"<string>\"\n ],\n \"email_medium\": \"<string>\"\n },\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"variables\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"company_plan_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"business_goal\": \"<string>\",\n \"touchpoint\": {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"start_at\": \"<string>\",\n \"assistant_id\": 123,\n \"customer_details\": [\n {\n \"id\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"additional_settings\": {\n \"execution_days\": [\n \"<string>\"\n ],\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"time_zone\": \"<string>\",\n \"email\": \"<string>\",\n \"from_emails\": [\n \"<string>\"\n ],\n \"email_medium\": \"<string>\"\n },\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"variables\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"ctx_id": "<string>",
"data": {
"id": "<string>",
"name": "<string>",
"status": "<string>"
}
}Create-Campaign
Create Campaign with Email Touchpoint
Create a new campaign with an email touchpoint.
POST
/
v2
/
_campaign
/
create_with_touchpoint
Create Campaign with Email Touchpoint
curl --request POST \
--url https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "<string>",
"company_plan_id": "<string>",
"workspace_id": "<string>",
"business_goal": "<string>",
"touchpoint": {
"name": "<string>",
"type": "<string>",
"status": "<string>",
"start_at": "<string>",
"assistant_id": 123,
"customer_details": [
{
"id": "<string>",
"email": "<string>"
}
],
"additional_settings": {
"execution_days": [
"<string>"
],
"start_hour": 123,
"end_hour": 123,
"time_zone": "<string>",
"email": "<string>",
"from_emails": [
"<string>"
],
"email_medium": "<string>"
},
"email_subject": "<string>",
"email_body": "<string>",
"variables": "<string>"
}
}
'import requests
url = "https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint"
payload = {
"name": "<string>",
"type": "<string>",
"company_plan_id": "<string>",
"workspace_id": "<string>",
"business_goal": "<string>",
"touchpoint": {
"name": "<string>",
"type": "<string>",
"status": "<string>",
"start_at": "<string>",
"assistant_id": 123,
"customer_details": [
{
"id": "<string>",
"email": "<string>"
}
],
"additional_settings": {
"execution_days": ["<string>"],
"start_hour": 123,
"end_hour": 123,
"time_zone": "<string>",
"email": "<string>",
"from_emails": ["<string>"],
"email_medium": "<string>"
},
"email_subject": "<string>",
"email_body": "<string>",
"variables": "<string>"
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: '<string>',
company_plan_id: '<string>',
workspace_id: '<string>',
business_goal: '<string>',
touchpoint: {
name: '<string>',
type: '<string>',
status: '<string>',
start_at: '<string>',
assistant_id: 123,
customer_details: [{id: '<string>', email: '<string>'}],
additional_settings: {
execution_days: ['<string>'],
start_hour: 123,
end_hour: 123,
time_zone: '<string>',
email: '<string>',
from_emails: ['<string>'],
email_medium: '<string>'
},
email_subject: '<string>',
email_body: '<string>',
variables: '<string>'
}
})
};
fetch('https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint', 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://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint",
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>',
'type' => '<string>',
'company_plan_id' => '<string>',
'workspace_id' => '<string>',
'business_goal' => '<string>',
'touchpoint' => [
'name' => '<string>',
'type' => '<string>',
'status' => '<string>',
'start_at' => '<string>',
'assistant_id' => 123,
'customer_details' => [
[
'id' => '<string>',
'email' => '<string>'
]
],
'additional_settings' => [
'execution_days' => [
'<string>'
],
'start_hour' => 123,
'end_hour' => 123,
'time_zone' => '<string>',
'email' => '<string>',
'from_emails' => [
'<string>'
],
'email_medium' => '<string>'
],
'email_subject' => '<string>',
'email_body' => '<string>',
'variables' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"company_plan_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"business_goal\": \"<string>\",\n \"touchpoint\": {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"start_at\": \"<string>\",\n \"assistant_id\": 123,\n \"customer_details\": [\n {\n \"id\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"additional_settings\": {\n \"execution_days\": [\n \"<string>\"\n ],\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"time_zone\": \"<string>\",\n \"email\": \"<string>\",\n \"from_emails\": [\n \"<string>\"\n ],\n \"email_medium\": \"<string>\"\n },\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"variables\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"company_plan_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"business_goal\": \"<string>\",\n \"touchpoint\": {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"start_at\": \"<string>\",\n \"assistant_id\": 123,\n \"customer_details\": [\n {\n \"id\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"additional_settings\": {\n \"execution_days\": [\n \"<string>\"\n ],\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"time_zone\": \"<string>\",\n \"email\": \"<string>\",\n \"from_emails\": [\n \"<string>\"\n ],\n \"email_medium\": \"<string>\"\n },\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"variables\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_campaign/create_with_touchpoint")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"company_plan_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"business_goal\": \"<string>\",\n \"touchpoint\": {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"start_at\": \"<string>\",\n \"assistant_id\": 123,\n \"customer_details\": [\n {\n \"id\": \"<string>\",\n \"email\": \"<string>\"\n }\n ],\n \"additional_settings\": {\n \"execution_days\": [\n \"<string>\"\n ],\n \"start_hour\": 123,\n \"end_hour\": 123,\n \"time_zone\": \"<string>\",\n \"email\": \"<string>\",\n \"from_emails\": [\n \"<string>\"\n ],\n \"email_medium\": \"<string>\"\n },\n \"email_subject\": \"<string>\",\n \"email_body\": \"<string>\",\n \"variables\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"ctx_id": "<string>",
"data": {
"id": "<string>",
"name": "<string>",
"status": "<string>"
}
}Authorizations
string
required
Enter your ContactSwing JWT Bearer token.
Request Body
string
required
Campaign display name
string
Campaign type.
string
Campaign type.
string
Campaign type.
string
The business goal of the campaign.
object
required
The touchpoint object.
string
required
The name of the touchpoint.
string
required
The type of the touchpoint. e.g.
EMAIL.string
required
The status of the touchpoint. e.g.
scheduled.string
required
ISO 8601 scheduled date for the touchpoint.
integer
required
The ID of the assistant to be used.
array
required
object
required
Additional settings for the touchpoint.
string[]
required
Array of days when the campaign will be executed. e.g.
["mon", "tue"]integer
required
The start hour for the campaign execution.
integer
required
The end hour for the campaign execution.
string
required
The timezone for the campaign execution. e.g.
Asia/Kolkata.string
required
The email address to be used.
string[]
required
The email addresses from which the emails will be sent.
string
required
The email medium to be used. e.g.
SEND_GRID.string
required
The subject of the email.
string
required
The body of the email in HTML format.
string
Response
201 Created - Campaign created successfullystring
Request context ID
⌘I