Update a broadcast.
curl --request PUT \
--url https://{subdomain}.outseta.com/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"Uid": "string",
"_objectType": "string",
"ActivityEventData": {},
"SendDateTime": "string",
"NextRunDateTime": "string",
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"Message": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Template": {},
"Name": "string",
"Subject": "string",
"PreviewText": "string",
"Body": "string",
"Design": "string",
"CountSent": 0,
"CountDelivered": 0,
"CountBounce": 0,
"CountSpam": 0,
"CountOpen": 0,
"CountClick": 0,
"CountUnsubscribed": 0,
"CountTotalOpen": 0,
"CountTotalClick": 0,
"IgnoredSpamBounce": 0,
"IsBounceRatePaused": false,
"IsSpamScorePaused": false,
"EmailLinks": [],
"SpamAssassinScore": 0,
"SpamStatus": 0,
"SpamReason": "string"
},
"RecipientData": "string",
"EmailListUids": [
"string"
],
"SegmentUids": [
"string"
],
"Status": 1,
"ErrorMessage": "string",
"Tags": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"SystemName": "string",
"SystemDescription": "string",
"TagColor": 1,
"EntityType": 0
}
]
}
'import requests
url = "https://{subdomain}.outseta.com/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid}"
payload = {
"Uid": "string",
"_objectType": "string",
"ActivityEventData": {},
"SendDateTime": "string",
"NextRunDateTime": "string",
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"Message": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Template": {},
"Name": "string",
"Subject": "string",
"PreviewText": "string",
"Body": "string",
"Design": "string",
"CountSent": 0,
"CountDelivered": 0,
"CountBounce": 0,
"CountSpam": 0,
"CountOpen": 0,
"CountClick": 0,
"CountUnsubscribed": 0,
"CountTotalOpen": 0,
"CountTotalClick": 0,
"IgnoredSpamBounce": 0,
"IsBounceRatePaused": False,
"IsSpamScorePaused": False,
"EmailLinks": [],
"SpamAssassinScore": 0,
"SpamStatus": 0,
"SpamReason": "string"
},
"RecipientData": "string",
"EmailListUids": ["string"],
"SegmentUids": ["string"],
"Status": 1,
"ErrorMessage": "string",
"Tags": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"SystemName": "string",
"SystemDescription": "string",
"TagColor": 1,
"EntityType": 0
}
]
}
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: {},
SendDateTime: 'string',
NextRunDateTime: 'string',
Campaign: {
Uid: 'string',
_objectType: 'string',
Created: 'string',
Updated: 'string',
ActivityEventData: {},
Name: 'string',
FromName: 'string',
FromEmail: 'string',
CampaignType: 1
},
Message: {
Uid: 'string',
_objectType: 'string',
Created: 'string',
Updated: 'string',
ActivityEventData: {},
Template: {},
Name: 'string',
Subject: 'string',
PreviewText: 'string',
Body: 'string',
Design: 'string',
CountSent: 0,
CountDelivered: 0,
CountBounce: 0,
CountSpam: 0,
CountOpen: 0,
CountClick: 0,
CountUnsubscribed: 0,
CountTotalOpen: 0,
CountTotalClick: 0,
IgnoredSpamBounce: 0,
IsBounceRatePaused: false,
IsSpamScorePaused: false,
EmailLinks: [],
SpamAssassinScore: 0,
SpamStatus: 0,
SpamReason: 'string'
},
RecipientData: 'string',
EmailListUids: ['string'],
SegmentUids: ['string'],
Status: 1,
ErrorMessage: 'string',
Tags: [
{
Uid: 'string',
_objectType: 'string',
Created: 'string',
Updated: 'string',
ActivityEventData: {},
Name: 'string',
SystemName: 'string',
SystemDescription: 'string',
TagColor: 1,
EntityType: 0
}
]
})
};
fetch('https://{subdomain}.outseta.com/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid}', 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/broadcasts/{broadcastCampaignUid}",
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' => [
],
'SendDateTime' => 'string',
'NextRunDateTime' => 'string',
'Campaign' => [
'Uid' => 'string',
'_objectType' => 'string',
'Created' => 'string',
'Updated' => 'string',
'ActivityEventData' => [
],
'Name' => 'string',
'FromName' => 'string',
'FromEmail' => 'string',
'CampaignType' => 1
],
'Message' => [
'Uid' => 'string',
'_objectType' => 'string',
'Created' => 'string',
'Updated' => 'string',
'ActivityEventData' => [
],
'Template' => [
],
'Name' => 'string',
'Subject' => 'string',
'PreviewText' => 'string',
'Body' => 'string',
'Design' => 'string',
'CountSent' => 0,
'CountDelivered' => 0,
'CountBounce' => 0,
'CountSpam' => 0,
'CountOpen' => 0,
'CountClick' => 0,
'CountUnsubscribed' => 0,
'CountTotalOpen' => 0,
'CountTotalClick' => 0,
'IgnoredSpamBounce' => 0,
'IsBounceRatePaused' => false,
'IsSpamScorePaused' => false,
'EmailLinks' => [
],
'SpamAssassinScore' => 0,
'SpamStatus' => 0,
'SpamReason' => 'string'
],
'RecipientData' => 'string',
'EmailListUids' => [
'string'
],
'SegmentUids' => [
'string'
],
'Status' => 1,
'ErrorMessage' => 'string',
'Tags' => [
[
'Uid' => 'string',
'_objectType' => 'string',
'Created' => 'string',
'Updated' => 'string',
'ActivityEventData' => [
],
'Name' => 'string',
'SystemName' => 'string',
'SystemDescription' => 'string',
'TagColor' => 1,
'EntityType' => 0
]
]
]),
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/broadcasts/{broadcastCampaignUid}"
payload := strings.NewReader("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"SendDateTime\": \"string\",\n \"NextRunDateTime\": \"string\",\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 \"Message\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Template\": {},\n \"Name\": \"string\",\n \"Subject\": \"string\",\n \"PreviewText\": \"string\",\n \"Body\": \"string\",\n \"Design\": \"string\",\n \"CountSent\": 0,\n \"CountDelivered\": 0,\n \"CountBounce\": 0,\n \"CountSpam\": 0,\n \"CountOpen\": 0,\n \"CountClick\": 0,\n \"CountUnsubscribed\": 0,\n \"CountTotalOpen\": 0,\n \"CountTotalClick\": 0,\n \"IgnoredSpamBounce\": 0,\n \"IsBounceRatePaused\": false,\n \"IsSpamScorePaused\": false,\n \"EmailLinks\": [],\n \"SpamAssassinScore\": 0,\n \"SpamStatus\": 0,\n \"SpamReason\": \"string\"\n },\n \"RecipientData\": \"string\",\n \"EmailListUids\": [\n \"string\"\n ],\n \"SegmentUids\": [\n \"string\"\n ],\n \"Status\": 1,\n \"ErrorMessage\": \"string\",\n \"Tags\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"SystemName\": \"string\",\n \"SystemDescription\": \"string\",\n \"TagColor\": 1,\n \"EntityType\": 0\n }\n ]\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/broadcasts/{broadcastCampaignUid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"SendDateTime\": \"string\",\n \"NextRunDateTime\": \"string\",\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 \"Message\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Template\": {},\n \"Name\": \"string\",\n \"Subject\": \"string\",\n \"PreviewText\": \"string\",\n \"Body\": \"string\",\n \"Design\": \"string\",\n \"CountSent\": 0,\n \"CountDelivered\": 0,\n \"CountBounce\": 0,\n \"CountSpam\": 0,\n \"CountOpen\": 0,\n \"CountClick\": 0,\n \"CountUnsubscribed\": 0,\n \"CountTotalOpen\": 0,\n \"CountTotalClick\": 0,\n \"IgnoredSpamBounce\": 0,\n \"IsBounceRatePaused\": false,\n \"IsSpamScorePaused\": false,\n \"EmailLinks\": [],\n \"SpamAssassinScore\": 0,\n \"SpamStatus\": 0,\n \"SpamReason\": \"string\"\n },\n \"RecipientData\": \"string\",\n \"EmailListUids\": [\n \"string\"\n ],\n \"SegmentUids\": [\n \"string\"\n ],\n \"Status\": 1,\n \"ErrorMessage\": \"string\",\n \"Tags\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"SystemName\": \"string\",\n \"SystemDescription\": \"string\",\n \"TagColor\": 1,\n \"EntityType\": 0\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.outseta.com/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid}")
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 \"SendDateTime\": \"string\",\n \"NextRunDateTime\": \"string\",\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 \"Message\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Template\": {},\n \"Name\": \"string\",\n \"Subject\": \"string\",\n \"PreviewText\": \"string\",\n \"Body\": \"string\",\n \"Design\": \"string\",\n \"CountSent\": 0,\n \"CountDelivered\": 0,\n \"CountBounce\": 0,\n \"CountSpam\": 0,\n \"CountOpen\": 0,\n \"CountClick\": 0,\n \"CountUnsubscribed\": 0,\n \"CountTotalOpen\": 0,\n \"CountTotalClick\": 0,\n \"IgnoredSpamBounce\": 0,\n \"IsBounceRatePaused\": false,\n \"IsSpamScorePaused\": false,\n \"EmailLinks\": [],\n \"SpamAssassinScore\": 0,\n \"SpamStatus\": 0,\n \"SpamReason\": \"string\"\n },\n \"RecipientData\": \"string\",\n \"EmailListUids\": [\n \"string\"\n ],\n \"SegmentUids\": [\n \"string\"\n ],\n \"Status\": 1,\n \"ErrorMessage\": \"string\",\n \"Tags\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"SystemName\": \"string\",\n \"SystemDescription\": \"string\",\n \"TagColor\": 1,\n \"EntityType\": 0\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"SendDateTime": "string",
"NextRunDateTime": "string",
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"Message": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Template": {},
"Name": "string",
"Subject": "string",
"PreviewText": "string",
"Body": "string",
"Design": "string",
"CountSent": 0,
"CountDelivered": 0,
"CountBounce": 0,
"CountSpam": 0,
"CountOpen": 0,
"CountClick": 0,
"CountUnsubscribed": 0,
"CountTotalOpen": 0,
"CountTotalClick": 0,
"IgnoredSpamBounce": 0,
"IsBounceRatePaused": false,
"IsSpamScorePaused": false,
"EmailLinks": [],
"SpamAssassinScore": 0,
"SpamStatus": 0,
"SpamReason": "string"
},
"RecipientData": "string",
"EmailListUids": [
"string"
],
"SegmentUids": [
"string"
],
"Status": 1,
"ErrorMessage": "string",
"Tags": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"SystemName": "string",
"SystemDescription": "string",
"TagColor": 1,
"EntityType": 0
}
]
}Broadcasts
Update a broadcast.
Setting SendDateTime to a future UTC date schedules the broadcast for sending and its status changes to Pending. An account may only have 5 broadcasts scheduled or sending at one time; scheduling beyond that is rejected until one finishes sending or is unscheduled. There is no limit on the number of drafts. Clearing SendDateTime unschedules the broadcast. Recipients can be added with EmailListUids and SegmentUids (see the create endpoint): on update these are merged onto the broadcast’s existing recipients and only ever add — to remove recipients or replace the set, send RecipientData directly.
When changing Message.Body, omit Message.Design: it is regenerated from the new Body so the drag-and-drop editor stays in sync. Sending a Design that was captured from an earlier response alongside an edited Body would otherwise keep the stale design. See the create endpoint for how Body is rendered (Liquid) and the unsubscribe-token expectation.
PUT
/
api
/
v1
/
email
/
campaigns
/
broadcasts
/
{broadcastCampaignUid}
Update a broadcast.
curl --request PUT \
--url https://{subdomain}.outseta.com/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"Uid": "string",
"_objectType": "string",
"ActivityEventData": {},
"SendDateTime": "string",
"NextRunDateTime": "string",
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"Message": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Template": {},
"Name": "string",
"Subject": "string",
"PreviewText": "string",
"Body": "string",
"Design": "string",
"CountSent": 0,
"CountDelivered": 0,
"CountBounce": 0,
"CountSpam": 0,
"CountOpen": 0,
"CountClick": 0,
"CountUnsubscribed": 0,
"CountTotalOpen": 0,
"CountTotalClick": 0,
"IgnoredSpamBounce": 0,
"IsBounceRatePaused": false,
"IsSpamScorePaused": false,
"EmailLinks": [],
"SpamAssassinScore": 0,
"SpamStatus": 0,
"SpamReason": "string"
},
"RecipientData": "string",
"EmailListUids": [
"string"
],
"SegmentUids": [
"string"
],
"Status": 1,
"ErrorMessage": "string",
"Tags": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"SystemName": "string",
"SystemDescription": "string",
"TagColor": 1,
"EntityType": 0
}
]
}
'import requests
url = "https://{subdomain}.outseta.com/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid}"
payload = {
"Uid": "string",
"_objectType": "string",
"ActivityEventData": {},
"SendDateTime": "string",
"NextRunDateTime": "string",
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"Message": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Template": {},
"Name": "string",
"Subject": "string",
"PreviewText": "string",
"Body": "string",
"Design": "string",
"CountSent": 0,
"CountDelivered": 0,
"CountBounce": 0,
"CountSpam": 0,
"CountOpen": 0,
"CountClick": 0,
"CountUnsubscribed": 0,
"CountTotalOpen": 0,
"CountTotalClick": 0,
"IgnoredSpamBounce": 0,
"IsBounceRatePaused": False,
"IsSpamScorePaused": False,
"EmailLinks": [],
"SpamAssassinScore": 0,
"SpamStatus": 0,
"SpamReason": "string"
},
"RecipientData": "string",
"EmailListUids": ["string"],
"SegmentUids": ["string"],
"Status": 1,
"ErrorMessage": "string",
"Tags": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"SystemName": "string",
"SystemDescription": "string",
"TagColor": 1,
"EntityType": 0
}
]
}
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: {},
SendDateTime: 'string',
NextRunDateTime: 'string',
Campaign: {
Uid: 'string',
_objectType: 'string',
Created: 'string',
Updated: 'string',
ActivityEventData: {},
Name: 'string',
FromName: 'string',
FromEmail: 'string',
CampaignType: 1
},
Message: {
Uid: 'string',
_objectType: 'string',
Created: 'string',
Updated: 'string',
ActivityEventData: {},
Template: {},
Name: 'string',
Subject: 'string',
PreviewText: 'string',
Body: 'string',
Design: 'string',
CountSent: 0,
CountDelivered: 0,
CountBounce: 0,
CountSpam: 0,
CountOpen: 0,
CountClick: 0,
CountUnsubscribed: 0,
CountTotalOpen: 0,
CountTotalClick: 0,
IgnoredSpamBounce: 0,
IsBounceRatePaused: false,
IsSpamScorePaused: false,
EmailLinks: [],
SpamAssassinScore: 0,
SpamStatus: 0,
SpamReason: 'string'
},
RecipientData: 'string',
EmailListUids: ['string'],
SegmentUids: ['string'],
Status: 1,
ErrorMessage: 'string',
Tags: [
{
Uid: 'string',
_objectType: 'string',
Created: 'string',
Updated: 'string',
ActivityEventData: {},
Name: 'string',
SystemName: 'string',
SystemDescription: 'string',
TagColor: 1,
EntityType: 0
}
]
})
};
fetch('https://{subdomain}.outseta.com/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid}', 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/broadcasts/{broadcastCampaignUid}",
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' => [
],
'SendDateTime' => 'string',
'NextRunDateTime' => 'string',
'Campaign' => [
'Uid' => 'string',
'_objectType' => 'string',
'Created' => 'string',
'Updated' => 'string',
'ActivityEventData' => [
],
'Name' => 'string',
'FromName' => 'string',
'FromEmail' => 'string',
'CampaignType' => 1
],
'Message' => [
'Uid' => 'string',
'_objectType' => 'string',
'Created' => 'string',
'Updated' => 'string',
'ActivityEventData' => [
],
'Template' => [
],
'Name' => 'string',
'Subject' => 'string',
'PreviewText' => 'string',
'Body' => 'string',
'Design' => 'string',
'CountSent' => 0,
'CountDelivered' => 0,
'CountBounce' => 0,
'CountSpam' => 0,
'CountOpen' => 0,
'CountClick' => 0,
'CountUnsubscribed' => 0,
'CountTotalOpen' => 0,
'CountTotalClick' => 0,
'IgnoredSpamBounce' => 0,
'IsBounceRatePaused' => false,
'IsSpamScorePaused' => false,
'EmailLinks' => [
],
'SpamAssassinScore' => 0,
'SpamStatus' => 0,
'SpamReason' => 'string'
],
'RecipientData' => 'string',
'EmailListUids' => [
'string'
],
'SegmentUids' => [
'string'
],
'Status' => 1,
'ErrorMessage' => 'string',
'Tags' => [
[
'Uid' => 'string',
'_objectType' => 'string',
'Created' => 'string',
'Updated' => 'string',
'ActivityEventData' => [
],
'Name' => 'string',
'SystemName' => 'string',
'SystemDescription' => 'string',
'TagColor' => 1,
'EntityType' => 0
]
]
]),
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/broadcasts/{broadcastCampaignUid}"
payload := strings.NewReader("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"SendDateTime\": \"string\",\n \"NextRunDateTime\": \"string\",\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 \"Message\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Template\": {},\n \"Name\": \"string\",\n \"Subject\": \"string\",\n \"PreviewText\": \"string\",\n \"Body\": \"string\",\n \"Design\": \"string\",\n \"CountSent\": 0,\n \"CountDelivered\": 0,\n \"CountBounce\": 0,\n \"CountSpam\": 0,\n \"CountOpen\": 0,\n \"CountClick\": 0,\n \"CountUnsubscribed\": 0,\n \"CountTotalOpen\": 0,\n \"CountTotalClick\": 0,\n \"IgnoredSpamBounce\": 0,\n \"IsBounceRatePaused\": false,\n \"IsSpamScorePaused\": false,\n \"EmailLinks\": [],\n \"SpamAssassinScore\": 0,\n \"SpamStatus\": 0,\n \"SpamReason\": \"string\"\n },\n \"RecipientData\": \"string\",\n \"EmailListUids\": [\n \"string\"\n ],\n \"SegmentUids\": [\n \"string\"\n ],\n \"Status\": 1,\n \"ErrorMessage\": \"string\",\n \"Tags\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"SystemName\": \"string\",\n \"SystemDescription\": \"string\",\n \"TagColor\": 1,\n \"EntityType\": 0\n }\n ]\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/broadcasts/{broadcastCampaignUid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"ActivityEventData\": {},\n \"SendDateTime\": \"string\",\n \"NextRunDateTime\": \"string\",\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 \"Message\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Template\": {},\n \"Name\": \"string\",\n \"Subject\": \"string\",\n \"PreviewText\": \"string\",\n \"Body\": \"string\",\n \"Design\": \"string\",\n \"CountSent\": 0,\n \"CountDelivered\": 0,\n \"CountBounce\": 0,\n \"CountSpam\": 0,\n \"CountOpen\": 0,\n \"CountClick\": 0,\n \"CountUnsubscribed\": 0,\n \"CountTotalOpen\": 0,\n \"CountTotalClick\": 0,\n \"IgnoredSpamBounce\": 0,\n \"IsBounceRatePaused\": false,\n \"IsSpamScorePaused\": false,\n \"EmailLinks\": [],\n \"SpamAssassinScore\": 0,\n \"SpamStatus\": 0,\n \"SpamReason\": \"string\"\n },\n \"RecipientData\": \"string\",\n \"EmailListUids\": [\n \"string\"\n ],\n \"SegmentUids\": [\n \"string\"\n ],\n \"Status\": 1,\n \"ErrorMessage\": \"string\",\n \"Tags\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"SystemName\": \"string\",\n \"SystemDescription\": \"string\",\n \"TagColor\": 1,\n \"EntityType\": 0\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.outseta.com/api/v1/email/campaigns/broadcasts/{broadcastCampaignUid}")
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 \"SendDateTime\": \"string\",\n \"NextRunDateTime\": \"string\",\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 \"Message\": {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Template\": {},\n \"Name\": \"string\",\n \"Subject\": \"string\",\n \"PreviewText\": \"string\",\n \"Body\": \"string\",\n \"Design\": \"string\",\n \"CountSent\": 0,\n \"CountDelivered\": 0,\n \"CountBounce\": 0,\n \"CountSpam\": 0,\n \"CountOpen\": 0,\n \"CountClick\": 0,\n \"CountUnsubscribed\": 0,\n \"CountTotalOpen\": 0,\n \"CountTotalClick\": 0,\n \"IgnoredSpamBounce\": 0,\n \"IsBounceRatePaused\": false,\n \"IsSpamScorePaused\": false,\n \"EmailLinks\": [],\n \"SpamAssassinScore\": 0,\n \"SpamStatus\": 0,\n \"SpamReason\": \"string\"\n },\n \"RecipientData\": \"string\",\n \"EmailListUids\": [\n \"string\"\n ],\n \"SegmentUids\": [\n \"string\"\n ],\n \"Status\": 1,\n \"ErrorMessage\": \"string\",\n \"Tags\": [\n {\n \"Uid\": \"string\",\n \"_objectType\": \"string\",\n \"Created\": \"string\",\n \"Updated\": \"string\",\n \"ActivityEventData\": {},\n \"Name\": \"string\",\n \"SystemName\": \"string\",\n \"SystemDescription\": \"string\",\n \"TagColor\": 1,\n \"EntityType\": 0\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"SendDateTime": "string",
"NextRunDateTime": "string",
"Campaign": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"FromName": "string",
"FromEmail": "string",
"CampaignType": 1
},
"Message": {
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Template": {},
"Name": "string",
"Subject": "string",
"PreviewText": "string",
"Body": "string",
"Design": "string",
"CountSent": 0,
"CountDelivered": 0,
"CountBounce": 0,
"CountSpam": 0,
"CountOpen": 0,
"CountClick": 0,
"CountUnsubscribed": 0,
"CountTotalOpen": 0,
"CountTotalClick": 0,
"IgnoredSpamBounce": 0,
"IsBounceRatePaused": false,
"IsSpamScorePaused": false,
"EmailLinks": [],
"SpamAssassinScore": 0,
"SpamStatus": 0,
"SpamReason": "string"
},
"RecipientData": "string",
"EmailListUids": [
"string"
],
"SegmentUids": [
"string"
],
"Status": 1,
"ErrorMessage": "string",
"Tags": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"Name": "string",
"SystemName": "string",
"SystemDescription": "string",
"TagColor": 1,
"EntityType": 0
}
]
}Authorizations
BearerApiKey
Enter your access token (OAuth / JWT).
Path Parameters
Body
application/json
The updated broadcast. The Uid in the body must match the broadcastCampaignUid in the URL.
Maximum string length:
10Show child attributes
Show child attributes
Show child attributes
Show child attributes
1 - Draft, 2 - Pending, 3 - Sent, 4 - Queuing, 5 - Queued, 6 - Sending, 7 - Error, 8 - WaitingToResume, 9 - QueuedEmails, 10 - Archived
Available options:
1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Maximum string length:
500Show 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
1 - Draft, 2 - Pending, 3 - Sent, 4 - Queuing, 5 - Queued, 6 - Sending, 7 - Error, 8 - WaitingToResume, 9 - QueuedEmails, 10 - Archived
Available options:
1, 2, 3, 4, 5, 6, 7, 8, 9, 10 Maximum string length:
500Show child attributes
Show child attributes
⌘I