Update a campaign
curl --request POST \
--url https://api.pocketflows.com/campaigns/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"segment": "<string>",
"enrolled_customers": "all",
"excluded_customers": [
"<string>"
],
"email_address": "<string>",
"phone_number": "<string>",
"scheduled_at": "<string>",
"metadata": {}
}
'import requests
url = "https://api.pocketflows.com/campaigns/{id}"
payload = {
"name": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"segment": "<string>",
"enrolled_customers": "all",
"excluded_customers": ["<string>"],
"email_address": "<string>",
"phone_number": "<string>",
"scheduled_at": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
steps: [{type: 'email', email_template_id: '<string>', custom_step_id: '<string>'}],
segment: '<string>',
enrolled_customers: 'all',
excluded_customers: ['<string>'],
email_address: '<string>',
phone_number: '<string>',
scheduled_at: '<string>',
metadata: {}
})
};
fetch('https://api.pocketflows.com/campaigns/{id}', 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.pocketflows.com/campaigns/{id}",
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>',
'steps' => [
[
'type' => 'email',
'email_template_id' => '<string>',
'custom_step_id' => '<string>'
]
],
'segment' => '<string>',
'enrolled_customers' => 'all',
'excluded_customers' => [
'<string>'
],
'email_address' => '<string>',
'phone_number' => '<string>',
'scheduled_at' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.pocketflows.com/campaigns/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"segment\": \"<string>\",\n \"enrolled_customers\": \"all\",\n \"excluded_customers\": [\n \"<string>\"\n ],\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.pocketflows.com/campaigns/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"segment\": \"<string>\",\n \"enrolled_customers\": \"all\",\n \"excluded_customers\": [\n \"<string>\"\n ],\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pocketflows.com/campaigns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"segment\": \"<string>\",\n \"enrolled_customers\": \"all\",\n \"excluded_customers\": [\n \"<string>\"\n ],\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"business": "<string>",
"name": "<string>",
"segment": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"email_address": "<string>",
"phone_number": "<string>",
"status": "draft",
"scheduled_at": "<string>",
"scheduled_end_at": "<string>",
"statistics": {
"emails": {
"sent": 123,
"delivered": 123,
"opened": 123,
"soft_bounced": 123,
"hard_bounced": 123,
"spam_reported": 123,
"clicked": 123
},
"custom_steps": [
{
"custom_step": "<string>",
"sent": 123
}
],
"executions": {
"total": 123,
"pending": 123,
"started": 123,
"finished": 123,
"errored": 123
},
"sms": {
"sms_sent_count": 123,
"sms_sent_segments_count": 123,
"mms_sent_count": 123,
"mms_sent_segments_count": 123
},
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"consumed_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"attributed_revenue": "<string>",
"metadata": {},
"enrolled_customers": [
"<string>"
],
"enrolled_customer_ids": [
"<string>"
],
"estimated_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
}
}Campaigns
Update a campaign
POST
/
campaigns
/
{id}
Update a campaign
curl --request POST \
--url https://api.pocketflows.com/campaigns/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"segment": "<string>",
"enrolled_customers": "all",
"excluded_customers": [
"<string>"
],
"email_address": "<string>",
"phone_number": "<string>",
"scheduled_at": "<string>",
"metadata": {}
}
'import requests
url = "https://api.pocketflows.com/campaigns/{id}"
payload = {
"name": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"segment": "<string>",
"enrolled_customers": "all",
"excluded_customers": ["<string>"],
"email_address": "<string>",
"phone_number": "<string>",
"scheduled_at": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
steps: [{type: 'email', email_template_id: '<string>', custom_step_id: '<string>'}],
segment: '<string>',
enrolled_customers: 'all',
excluded_customers: ['<string>'],
email_address: '<string>',
phone_number: '<string>',
scheduled_at: '<string>',
metadata: {}
})
};
fetch('https://api.pocketflows.com/campaigns/{id}', 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.pocketflows.com/campaigns/{id}",
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>',
'steps' => [
[
'type' => 'email',
'email_template_id' => '<string>',
'custom_step_id' => '<string>'
]
],
'segment' => '<string>',
'enrolled_customers' => 'all',
'excluded_customers' => [
'<string>'
],
'email_address' => '<string>',
'phone_number' => '<string>',
'scheduled_at' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.pocketflows.com/campaigns/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"segment\": \"<string>\",\n \"enrolled_customers\": \"all\",\n \"excluded_customers\": [\n \"<string>\"\n ],\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.pocketflows.com/campaigns/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"segment\": \"<string>\",\n \"enrolled_customers\": \"all\",\n \"excluded_customers\": [\n \"<string>\"\n ],\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pocketflows.com/campaigns/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"email\",\n \"email_template_id\": \"<string>\",\n \"custom_step_id\": \"<string>\"\n }\n ],\n \"segment\": \"<string>\",\n \"enrolled_customers\": \"all\",\n \"excluded_customers\": [\n \"<string>\"\n ],\n \"email_address\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"business": "<string>",
"name": "<string>",
"segment": "<string>",
"steps": [
{
"type": "email",
"email_template_id": "<string>",
"custom_step_id": "<string>"
}
],
"email_address": "<string>",
"phone_number": "<string>",
"status": "draft",
"scheduled_at": "<string>",
"scheduled_end_at": "<string>",
"statistics": {
"emails": {
"sent": 123,
"delivered": 123,
"opened": 123,
"soft_bounced": 123,
"hard_bounced": 123,
"spam_reported": 123,
"clicked": 123
},
"custom_steps": [
{
"custom_step": "<string>",
"sent": 123
}
],
"executions": {
"total": 123,
"pending": 123,
"started": 123,
"finished": 123,
"errored": 123
},
"sms": {
"sms_sent_count": 123,
"sms_sent_segments_count": 123,
"mms_sent_count": 123,
"mms_sent_segments_count": 123
},
"total_customers_enrolled": 123,
"total_customers_started": 123,
"total_customers_finished": 123
},
"consumed_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
},
"attributed_revenue": "<string>",
"metadata": {},
"enrolled_customers": [
"<string>"
],
"enrolled_customer_ids": [
"<string>"
],
"estimated_message_segments": {
"sms": 123,
"mms": 123,
"email": 123
}
}Authorizations
Body
application/json
Response
200 - application/json
The updated Campaign object