Update a drip campaign.
curl --request PUT \
--url https://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"Uid": "string",
"_objectType": "string",
"ActivityEventData": {},
"IsActive": false,
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"TriggerId": 0,
"TriggerStartValue": "string",
"TriggerStopValue": "string",
"DripCampaignMessages": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"DripCampaign": {},
"Message": {},
"DelayFromPriorDay": 0,
"DelayInHours": 0,
"Weight": 0
}
],
"AllowRepeatProcessing": false,
"StartDripToExistingMembers": false
}
'import requests
url = "https://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}"
payload = {
"Uid": "string",
"_objectType": "string",
"ActivityEventData": {},
"IsActive": False,
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"TriggerId": 0,
"TriggerStartValue": "string",
"TriggerStopValue": "string",
"DripCampaignMessages": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"DripCampaign": {},
"Message": {},
"DelayFromPriorDay": 0,
"DelayInHours": 0,
"Weight": 0
}
],
"AllowRepeatProcessing": False,
"StartDripToExistingMembers": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Uid: 'string',
_objectType: 'string',
ActivityEventData: {},
IsActive: false,
Campaign: {
Uid: 'string',
_objectType: 'string',
Created: 'string',
Updated: 'string',
ActivityEventData: {},
Name: 'string',
FromName: 'string',
FromEmail: 'string',
CampaignType: 1
},
TriggerId: 0,
TriggerStartValue: 'string',
TriggerStopValue: 'string',
DripCampaignMessages: [
{
Uid: 'string',
_objectType: 'string',
Created: 'string',
Updated: 'string',
ActivityEventData: {},
DripCampaign: {},
Message: {},
DelayFromPriorDay: 0,
DelayInHours: 0,
Weight: 0
}
],
AllowRepeatProcessing: false,
StartDripToExistingMembers: false
})
};
fetch('https://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}', 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://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'Uid' => 'string',
'_objectType' => 'string',
'ActivityEventData' => [
],
'IsActive' => false,
'Campaign' => [
'Uid' => 'string',
'_objectType' => 'string',
'Created' => 'string',
'Updated' => 'string',
'ActivityEventData' => [
],
'Name' => 'string',
'FromName' => 'string',
'FromEmail' => 'string',
'CampaignType' => 1
],
'TriggerId' => 0,
'TriggerStartValue' => 'string',
'TriggerStopValue' => 'string',
'DripCampaignMessages' => [
[
'Uid' => 'string',
'_objectType' => 'string',
'Created' => 'string',
'Updated' => 'string',
'ActivityEventData' => [
],
'DripCampaign' => [
],
'Message' => [
],
'DelayFromPriorDay' => 0,
'DelayInHours' => 0,
'Weight' => 0
]
],
'AllowRepeatProcessing' => false,
'StartDripToExistingMembers' => false
]),
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://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}"
payload := strings.NewReader("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"IsActive\": false,\n \"Campaign\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"FromName\": \"string\",\n \"FromEmail\": \"string\",\n \"CampaignType\": 1\n },\n \"TriggerId\": 0,\n \"TriggerStartValue\": \"string\",\n \"TriggerStopValue\": \"string\",\n \"DripCampaignMessages\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"DripCampaign\": {},\n \"Message\": {},\n \"DelayFromPriorDay\": 0,\n \"DelayInHours\": 0,\n \"Weight\": 0\n }\n ],\n \"AllowRepeatProcessing\": false,\n \"StartDripToExistingMembers\": false\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"IsActive\": false,\n \"Campaign\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"FromName\": \"string\",\n \"FromEmail\": \"string\",\n \"CampaignType\": 1\n },\n \"TriggerId\": 0,\n \"TriggerStartValue\": \"string\",\n \"TriggerStopValue\": \"string\",\n \"DripCampaignMessages\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"DripCampaign\": {},\n \"Message\": {},\n \"DelayFromPriorDay\": 0,\n \"DelayInHours\": 0,\n \"Weight\": 0\n }\n ],\n \"AllowRepeatProcessing\": false,\n \"StartDripToExistingMembers\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"IsActive\": false,\n \"Campaign\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"FromName\": \"string\",\n \"FromEmail\": \"string\",\n \"CampaignType\": 1\n },\n \"TriggerId\": 0,\n \"TriggerStartValue\": \"string\",\n \"TriggerStopValue\": \"string\",\n \"DripCampaignMessages\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"DripCampaign\": {},\n \"Message\": {},\n \"DelayFromPriorDay\": 0,\n \"DelayInHours\": 0,\n \"Weight\": 0\n }\n ],\n \"AllowRepeatProcessing\": false,\n \"StartDripToExistingMembers\": false\n}"
response = http.request(request)
puts response.read_body{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"IsActive": false,
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"TriggerId": 0,
"TriggerStartValue": "string",
"TriggerStopValue": "string",
"DripCampaignMessages": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"DripCampaign": {},
"Message": {},
"DelayFromPriorDay": 0,
"DelayInHours": 0,
"Weight": 0
}
],
"AllowRepeatProcessing": false,
"StartDripToExistingMembers": false
}Drip campaigns
Update a drip campaign.
Activating a drip campaign (setting IsActive) begins sending its messages to members. StartDripToExistingMembers controls whether members already in the campaign receive the messages or only members added going forward.
PUT
/
api
/
v1
/
email
/
campaigns
/
drips
/
{dripCampaignUid}
Update a drip campaign.
curl --request PUT \
--url https://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"Uid": "string",
"_objectType": "string",
"ActivityEventData": {},
"IsActive": false,
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"TriggerId": 0,
"TriggerStartValue": "string",
"TriggerStopValue": "string",
"DripCampaignMessages": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"DripCampaign": {},
"Message": {},
"DelayFromPriorDay": 0,
"DelayInHours": 0,
"Weight": 0
}
],
"AllowRepeatProcessing": false,
"StartDripToExistingMembers": false
}
'import requests
url = "https://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}"
payload = {
"Uid": "string",
"_objectType": "string",
"ActivityEventData": {},
"IsActive": False,
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"TriggerId": 0,
"TriggerStartValue": "string",
"TriggerStopValue": "string",
"DripCampaignMessages": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"DripCampaign": {},
"Message": {},
"DelayFromPriorDay": 0,
"DelayInHours": 0,
"Weight": 0
}
],
"AllowRepeatProcessing": False,
"StartDripToExistingMembers": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Uid: 'string',
_objectType: 'string',
ActivityEventData: {},
IsActive: false,
Campaign: {
Uid: 'string',
_objectType: 'string',
Created: 'string',
Updated: 'string',
ActivityEventData: {},
Name: 'string',
FromName: 'string',
FromEmail: 'string',
CampaignType: 1
},
TriggerId: 0,
TriggerStartValue: 'string',
TriggerStopValue: 'string',
DripCampaignMessages: [
{
Uid: 'string',
_objectType: 'string',
Created: 'string',
Updated: 'string',
ActivityEventData: {},
DripCampaign: {},
Message: {},
DelayFromPriorDay: 0,
DelayInHours: 0,
Weight: 0
}
],
AllowRepeatProcessing: false,
StartDripToExistingMembers: false
})
};
fetch('https://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}', 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://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'Uid' => 'string',
'_objectType' => 'string',
'ActivityEventData' => [
],
'IsActive' => false,
'Campaign' => [
'Uid' => 'string',
'_objectType' => 'string',
'Created' => 'string',
'Updated' => 'string',
'ActivityEventData' => [
],
'Name' => 'string',
'FromName' => 'string',
'FromEmail' => 'string',
'CampaignType' => 1
],
'TriggerId' => 0,
'TriggerStartValue' => 'string',
'TriggerStopValue' => 'string',
'DripCampaignMessages' => [
[
'Uid' => 'string',
'_objectType' => 'string',
'Created' => 'string',
'Updated' => 'string',
'ActivityEventData' => [
],
'DripCampaign' => [
],
'Message' => [
],
'DelayFromPriorDay' => 0,
'DelayInHours' => 0,
'Weight' => 0
]
],
'AllowRepeatProcessing' => false,
'StartDripToExistingMembers' => false
]),
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://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}"
payload := strings.NewReader("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"IsActive\": false,\n \"Campaign\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"FromName\": \"string\",\n \"FromEmail\": \"string\",\n \"CampaignType\": 1\n },\n \"TriggerId\": 0,\n \"TriggerStartValue\": \"string\",\n \"TriggerStopValue\": \"string\",\n \"DripCampaignMessages\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"DripCampaign\": {},\n \"Message\": {},\n \"DelayFromPriorDay\": 0,\n \"DelayInHours\": 0,\n \"Weight\": 0\n }\n ],\n \"AllowRepeatProcessing\": false,\n \"StartDripToExistingMembers\": false\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"IsActive\": false,\n \"Campaign\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"FromName\": \"string\",\n \"FromEmail\": \"string\",\n \"CampaignType\": 1\n },\n \"TriggerId\": 0,\n \"TriggerStartValue\": \"string\",\n \"TriggerStopValue\": \"string\",\n \"DripCampaignMessages\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"DripCampaign\": {},\n \"Message\": {},\n \"DelayFromPriorDay\": 0,\n \"DelayInHours\": 0,\n \"Weight\": 0\n }\n ],\n \"AllowRepeatProcessing\": false,\n \"StartDripToExistingMembers\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.outseta.com/api/v1/email/campaigns/drips/{dripCampaignUid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"IsActive\": false,\n \"Campaign\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"FromName\": \"string\",\n \"FromEmail\": \"string\",\n \"CampaignType\": 1\n },\n \"TriggerId\": 0,\n \"TriggerStartValue\": \"string\",\n \"TriggerStopValue\": \"string\",\n \"DripCampaignMessages\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"DripCampaign\": {},\n \"Message\": {},\n \"DelayFromPriorDay\": 0,\n \"DelayInHours\": 0,\n \"Weight\": 0\n }\n ],\n \"AllowRepeatProcessing\": false,\n \"StartDripToExistingMembers\": false\n}"
response = http.request(request)
puts response.read_body{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"IsActive": false,
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"TriggerId": 0,
"TriggerStartValue": "string",
"TriggerStopValue": "string",
"DripCampaignMessages": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"DripCampaign": {},
"Message": {},
"DelayFromPriorDay": 0,
"DelayInHours": 0,
"Weight": 0
}
],
"AllowRepeatProcessing": false,
"StartDripToExistingMembers": false
}Authorizations
BearerApiKey
Enter your access token (OAuth / JWT).
Path Parameters
The drip campaign's unique identifier.
Body
application/json
The updated drip campaign.
Maximum string length:
10Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Minimum string length:
1Minimum string length:
1Maximum string length:
10Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I