Update a campaign
curl --request PATCH \
--url https://api.journeybee.io/v1/campaigns/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"type": "<string>",
"description": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"scheduled_at": "<string>",
"timezone": "<string>",
"venue": "<string>",
"physical_address": "<string>",
"status": "<string>",
"completed": true,
"lead_sharing_enabled": true,
"partner_type_referral": true,
"partner_type_reseller": true,
"partner_type_distributor": true,
"enabled_modules": [],
"email_template_uuid": "<string>"
}
'import requests
url = "https://api.journeybee.io/v1/campaigns/{uuid}"
payload = {
"title": "<string>",
"type": "<string>",
"description": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"scheduled_at": "<string>",
"timezone": "<string>",
"venue": "<string>",
"physical_address": "<string>",
"status": "<string>",
"completed": True,
"lead_sharing_enabled": True,
"partner_type_referral": True,
"partner_type_reseller": True,
"partner_type_distributor": True,
"enabled_modules": [],
"email_template_uuid": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
type: '<string>',
description: '<string>',
start_date: '<string>',
end_date: '<string>',
scheduled_at: '<string>',
timezone: '<string>',
venue: '<string>',
physical_address: '<string>',
status: '<string>',
completed: true,
lead_sharing_enabled: true,
partner_type_referral: true,
partner_type_reseller: true,
partner_type_distributor: true,
enabled_modules: [],
email_template_uuid: '<string>'
})
};
fetch('https://api.journeybee.io/v1/campaigns/{uuid}', 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.journeybee.io/v1/campaigns/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'type' => '<string>',
'description' => '<string>',
'start_date' => '<string>',
'end_date' => '<string>',
'scheduled_at' => '<string>',
'timezone' => '<string>',
'venue' => '<string>',
'physical_address' => '<string>',
'status' => '<string>',
'completed' => true,
'lead_sharing_enabled' => true,
'partner_type_referral' => true,
'partner_type_reseller' => true,
'partner_type_distributor' => true,
'enabled_modules' => [
],
'email_template_uuid' => '<string>'
]),
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.journeybee.io/v1/campaigns/{uuid}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"venue\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"status\": \"<string>\",\n \"completed\": true,\n \"lead_sharing_enabled\": true,\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"enabled_modules\": [],\n \"email_template_uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.journeybee.io/v1/campaigns/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"venue\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"status\": \"<string>\",\n \"completed\": true,\n \"lead_sharing_enabled\": true,\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"enabled_modules\": [],\n \"email_template_uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/campaigns/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"venue\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"status\": \"<string>\",\n \"completed\": true,\n \"lead_sharing_enabled\": true,\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"enabled_modules\": [],\n \"email_template_uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"title": "<string>",
"type": "<string>",
"description": "<string>",
"status": "<string>",
"completed": true,
"lead_sharing_enabled": true,
"start_date": "<string>",
"end_date": "<string>",
"scheduled_at": "<string>",
"timezone": "<string>",
"venue": "<string>",
"physical_address": "<string>",
"partner_type_referral": true,
"partner_type_reseller": true,
"partner_type_distributor": true,
"enabled_modules": [],
"email_template": {
"uuid": "<string>",
"name": "<string>",
"subject": "<string>"
},
"tags": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"created_at": "<string>",
"updated_at": "<string>",
"tiers": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"categories": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"stages": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"partners": [
{
"uuid": "<string>",
"name": "<string>",
"shared": true,
"shared_leads": true
}
],
"recipient_partnerships": [
{
"uuid": "<string>",
"name": "<string>"
}
],
"contact_tags": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"contacts": [
{
"uuid": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>"
}
]
}Campaigns
Update a campaign
Update campaign fields, including status, schedule, partner-type audience flags, and the linked email template (email_template_uuid; null clears it). Audience filters and partner sharing are managed via the sub-resource endpoints.
PATCH
/
campaigns
/
{uuid}
Update a campaign
curl --request PATCH \
--url https://api.journeybee.io/v1/campaigns/{uuid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"type": "<string>",
"description": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"scheduled_at": "<string>",
"timezone": "<string>",
"venue": "<string>",
"physical_address": "<string>",
"status": "<string>",
"completed": true,
"lead_sharing_enabled": true,
"partner_type_referral": true,
"partner_type_reseller": true,
"partner_type_distributor": true,
"enabled_modules": [],
"email_template_uuid": "<string>"
}
'import requests
url = "https://api.journeybee.io/v1/campaigns/{uuid}"
payload = {
"title": "<string>",
"type": "<string>",
"description": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"scheduled_at": "<string>",
"timezone": "<string>",
"venue": "<string>",
"physical_address": "<string>",
"status": "<string>",
"completed": True,
"lead_sharing_enabled": True,
"partner_type_referral": True,
"partner_type_reseller": True,
"partner_type_distributor": True,
"enabled_modules": [],
"email_template_uuid": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
type: '<string>',
description: '<string>',
start_date: '<string>',
end_date: '<string>',
scheduled_at: '<string>',
timezone: '<string>',
venue: '<string>',
physical_address: '<string>',
status: '<string>',
completed: true,
lead_sharing_enabled: true,
partner_type_referral: true,
partner_type_reseller: true,
partner_type_distributor: true,
enabled_modules: [],
email_template_uuid: '<string>'
})
};
fetch('https://api.journeybee.io/v1/campaigns/{uuid}', 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.journeybee.io/v1/campaigns/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'type' => '<string>',
'description' => '<string>',
'start_date' => '<string>',
'end_date' => '<string>',
'scheduled_at' => '<string>',
'timezone' => '<string>',
'venue' => '<string>',
'physical_address' => '<string>',
'status' => '<string>',
'completed' => true,
'lead_sharing_enabled' => true,
'partner_type_referral' => true,
'partner_type_reseller' => true,
'partner_type_distributor' => true,
'enabled_modules' => [
],
'email_template_uuid' => '<string>'
]),
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.journeybee.io/v1/campaigns/{uuid}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"venue\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"status\": \"<string>\",\n \"completed\": true,\n \"lead_sharing_enabled\": true,\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"enabled_modules\": [],\n \"email_template_uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.journeybee.io/v1/campaigns/{uuid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"venue\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"status\": \"<string>\",\n \"completed\": true,\n \"lead_sharing_enabled\": true,\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"enabled_modules\": [],\n \"email_template_uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/campaigns/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"start_date\": \"<string>\",\n \"end_date\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"timezone\": \"<string>\",\n \"venue\": \"<string>\",\n \"physical_address\": \"<string>\",\n \"status\": \"<string>\",\n \"completed\": true,\n \"lead_sharing_enabled\": true,\n \"partner_type_referral\": true,\n \"partner_type_reseller\": true,\n \"partner_type_distributor\": true,\n \"enabled_modules\": [],\n \"email_template_uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"title": "<string>",
"type": "<string>",
"description": "<string>",
"status": "<string>",
"completed": true,
"lead_sharing_enabled": true,
"start_date": "<string>",
"end_date": "<string>",
"scheduled_at": "<string>",
"timezone": "<string>",
"venue": "<string>",
"physical_address": "<string>",
"partner_type_referral": true,
"partner_type_reseller": true,
"partner_type_distributor": true,
"enabled_modules": [],
"email_template": {
"uuid": "<string>",
"name": "<string>",
"subject": "<string>"
},
"tags": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"created_at": "<string>",
"updated_at": "<string>",
"tiers": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"categories": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"stages": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"partners": [
{
"uuid": "<string>",
"name": "<string>",
"shared": true,
"shared_leads": true
}
],
"recipient_partnerships": [
{
"uuid": "<string>",
"name": "<string>"
}
],
"contact_tags": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"contacts": [
{
"uuid": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>"
}
]
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Path Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Body
application/json
Available options:
details, schedule, partners, audience, recipients, email, templates, forms, tags, notes, leads, analytics, assets, mdf, social, settings Response
200 - application/json
Default Response
Available options:
draft, scheduled, sending, sent, partial, failed, cancelled Available options:
details, schedule, partners, audience, recipients, email, templates, forms, tags, notes, leads, analytics, assets, mdf, social, settings Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I