Change a campaign
curl --request PATCH \
--url https://api.statisfy.com/v1/campaigns/{campaign_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"audience_id": "<string>",
"bcc_emails": [
"<string>"
],
"bcc_roles": [
{
"field_id": "<string>"
}
],
"cc_emails": [
"<string>"
],
"cc_roles": [
{
"field_id": "<string>"
}
],
"description": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"name": null,
"reminder_days": 183,
"send_hour": 11,
"send_timezone": "<string>",
"sender_role": {
"field_id": "<string>"
},
"skip_weekends": true,
"start_date": "2023-11-07T05:31:56Z",
"survey_id": "<string>",
"template_id": "<string>",
"type": null
}
'import requests
url = "https://api.statisfy.com/v1/campaigns/{campaign_id}"
payload = {
"audience_id": "<string>",
"bcc_emails": ["<string>"],
"bcc_roles": [{ "field_id": "<string>" }],
"cc_emails": ["<string>"],
"cc_roles": [{ "field_id": "<string>" }],
"description": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"name": None,
"reminder_days": 183,
"send_hour": 11,
"send_timezone": "<string>",
"sender_role": { "field_id": "<string>" },
"skip_weekends": True,
"start_date": "2023-11-07T05:31:56Z",
"survey_id": "<string>",
"template_id": "<string>",
"type": None
}
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({
audience_id: '<string>',
bcc_emails: ['<string>'],
bcc_roles: [{field_id: '<string>'}],
cc_emails: ['<string>'],
cc_roles: [{field_id: '<string>'}],
description: '<string>',
end_date: '2023-11-07T05:31:56Z',
name: null,
reminder_days: 183,
send_hour: 11,
send_timezone: '<string>',
sender_role: {field_id: '<string>'},
skip_weekends: true,
start_date: '2023-11-07T05:31:56Z',
survey_id: '<string>',
template_id: '<string>',
type: null
})
};
fetch('https://api.statisfy.com/v1/campaigns/{campaign_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.statisfy.com/v1/campaigns/{campaign_id}",
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([
'audience_id' => '<string>',
'bcc_emails' => [
'<string>'
],
'bcc_roles' => [
[
'field_id' => '<string>'
]
],
'cc_emails' => [
'<string>'
],
'cc_roles' => [
[
'field_id' => '<string>'
]
],
'description' => '<string>',
'end_date' => '2023-11-07T05:31:56Z',
'name' => null,
'reminder_days' => 183,
'send_hour' => 11,
'send_timezone' => '<string>',
'sender_role' => [
'field_id' => '<string>'
],
'skip_weekends' => true,
'start_date' => '2023-11-07T05:31:56Z',
'survey_id' => '<string>',
'template_id' => '<string>',
'type' => null
]),
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.statisfy.com/v1/campaigns/{campaign_id}"
payload := strings.NewReader("{\n \"audience_id\": \"<string>\",\n \"bcc_emails\": [\n \"<string>\"\n ],\n \"bcc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"cc_emails\": [\n \"<string>\"\n ],\n \"cc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"name\": null,\n \"reminder_days\": 183,\n \"send_hour\": 11,\n \"send_timezone\": \"<string>\",\n \"sender_role\": {\n \"field_id\": \"<string>\"\n },\n \"skip_weekends\": true,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"survey_id\": \"<string>\",\n \"template_id\": \"<string>\",\n \"type\": null\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.statisfy.com/v1/campaigns/{campaign_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"audience_id\": \"<string>\",\n \"bcc_emails\": [\n \"<string>\"\n ],\n \"bcc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"cc_emails\": [\n \"<string>\"\n ],\n \"cc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"name\": null,\n \"reminder_days\": 183,\n \"send_hour\": 11,\n \"send_timezone\": \"<string>\",\n \"sender_role\": {\n \"field_id\": \"<string>\"\n },\n \"skip_weekends\": true,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"survey_id\": \"<string>\",\n \"template_id\": \"<string>\",\n \"type\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/campaigns/{campaign_id}")
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 \"audience_id\": \"<string>\",\n \"bcc_emails\": [\n \"<string>\"\n ],\n \"bcc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"cc_emails\": [\n \"<string>\"\n ],\n \"cc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"name\": null,\n \"reminder_days\": 183,\n \"send_hour\": 11,\n \"send_timezone\": \"<string>\",\n \"sender_role\": {\n \"field_id\": \"<string>\"\n },\n \"skip_weekends\": true,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"survey_id\": \"<string>\",\n \"template_id\": \"<string>\",\n \"type\": null\n}"
response = http.request(request)
puts response.read_body{
"audience_id": "<string>",
"bcc_emails": [
"<string>"
],
"bcc_roles": [
{
"field_id": "<string>",
"name": "<string>"
}
],
"cc_emails": [
"<string>"
],
"cc_roles": [
{
"field_id": "<string>",
"name": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"reminder_days": 123,
"send_hour": 123,
"send_timezone": "<string>",
"sender_role": {
"field_id": "<string>",
"name": "<string>"
},
"skip_weekends": true,
"start_date": "2023-11-07T05:31:56Z",
"state": "draft",
"survey_id": "<string>",
"template_id": "<string>",
"type": "email",
"updated_at": "2023-11-07T05:31:56Z"
}campaigns
Change a campaign
Changes what you send of a campaign’s settings; null clears a setting. A published campaign can be changed only with campaigns:publish too (a 403 otherwise), and a change it can’t send with returns 422.
PATCH
/
v1
/
campaigns
/
{campaign_id}
Change a campaign
curl --request PATCH \
--url https://api.statisfy.com/v1/campaigns/{campaign_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"audience_id": "<string>",
"bcc_emails": [
"<string>"
],
"bcc_roles": [
{
"field_id": "<string>"
}
],
"cc_emails": [
"<string>"
],
"cc_roles": [
{
"field_id": "<string>"
}
],
"description": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"name": null,
"reminder_days": 183,
"send_hour": 11,
"send_timezone": "<string>",
"sender_role": {
"field_id": "<string>"
},
"skip_weekends": true,
"start_date": "2023-11-07T05:31:56Z",
"survey_id": "<string>",
"template_id": "<string>",
"type": null
}
'import requests
url = "https://api.statisfy.com/v1/campaigns/{campaign_id}"
payload = {
"audience_id": "<string>",
"bcc_emails": ["<string>"],
"bcc_roles": [{ "field_id": "<string>" }],
"cc_emails": ["<string>"],
"cc_roles": [{ "field_id": "<string>" }],
"description": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"name": None,
"reminder_days": 183,
"send_hour": 11,
"send_timezone": "<string>",
"sender_role": { "field_id": "<string>" },
"skip_weekends": True,
"start_date": "2023-11-07T05:31:56Z",
"survey_id": "<string>",
"template_id": "<string>",
"type": None
}
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({
audience_id: '<string>',
bcc_emails: ['<string>'],
bcc_roles: [{field_id: '<string>'}],
cc_emails: ['<string>'],
cc_roles: [{field_id: '<string>'}],
description: '<string>',
end_date: '2023-11-07T05:31:56Z',
name: null,
reminder_days: 183,
send_hour: 11,
send_timezone: '<string>',
sender_role: {field_id: '<string>'},
skip_weekends: true,
start_date: '2023-11-07T05:31:56Z',
survey_id: '<string>',
template_id: '<string>',
type: null
})
};
fetch('https://api.statisfy.com/v1/campaigns/{campaign_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.statisfy.com/v1/campaigns/{campaign_id}",
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([
'audience_id' => '<string>',
'bcc_emails' => [
'<string>'
],
'bcc_roles' => [
[
'field_id' => '<string>'
]
],
'cc_emails' => [
'<string>'
],
'cc_roles' => [
[
'field_id' => '<string>'
]
],
'description' => '<string>',
'end_date' => '2023-11-07T05:31:56Z',
'name' => null,
'reminder_days' => 183,
'send_hour' => 11,
'send_timezone' => '<string>',
'sender_role' => [
'field_id' => '<string>'
],
'skip_weekends' => true,
'start_date' => '2023-11-07T05:31:56Z',
'survey_id' => '<string>',
'template_id' => '<string>',
'type' => null
]),
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.statisfy.com/v1/campaigns/{campaign_id}"
payload := strings.NewReader("{\n \"audience_id\": \"<string>\",\n \"bcc_emails\": [\n \"<string>\"\n ],\n \"bcc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"cc_emails\": [\n \"<string>\"\n ],\n \"cc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"name\": null,\n \"reminder_days\": 183,\n \"send_hour\": 11,\n \"send_timezone\": \"<string>\",\n \"sender_role\": {\n \"field_id\": \"<string>\"\n },\n \"skip_weekends\": true,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"survey_id\": \"<string>\",\n \"template_id\": \"<string>\",\n \"type\": null\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.statisfy.com/v1/campaigns/{campaign_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"audience_id\": \"<string>\",\n \"bcc_emails\": [\n \"<string>\"\n ],\n \"bcc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"cc_emails\": [\n \"<string>\"\n ],\n \"cc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"name\": null,\n \"reminder_days\": 183,\n \"send_hour\": 11,\n \"send_timezone\": \"<string>\",\n \"sender_role\": {\n \"field_id\": \"<string>\"\n },\n \"skip_weekends\": true,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"survey_id\": \"<string>\",\n \"template_id\": \"<string>\",\n \"type\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/campaigns/{campaign_id}")
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 \"audience_id\": \"<string>\",\n \"bcc_emails\": [\n \"<string>\"\n ],\n \"bcc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"cc_emails\": [\n \"<string>\"\n ],\n \"cc_roles\": [\n {\n \"field_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"name\": null,\n \"reminder_days\": 183,\n \"send_hour\": 11,\n \"send_timezone\": \"<string>\",\n \"sender_role\": {\n \"field_id\": \"<string>\"\n },\n \"skip_weekends\": true,\n \"start_date\": \"2023-11-07T05:31:56Z\",\n \"survey_id\": \"<string>\",\n \"template_id\": \"<string>\",\n \"type\": null\n}"
response = http.request(request)
puts response.read_body{
"audience_id": "<string>",
"bcc_emails": [
"<string>"
],
"bcc_roles": [
{
"field_id": "<string>",
"name": "<string>"
}
],
"cc_emails": [
"<string>"
],
"cc_roles": [
{
"field_id": "<string>",
"name": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"end_date": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"reminder_days": 123,
"send_hour": 123,
"send_timezone": "<string>",
"sender_role": {
"field_id": "<string>",
"name": "<string>"
},
"skip_weekends": true,
"start_date": "2023-11-07T05:31:56Z",
"state": "draft",
"survey_id": "<string>",
"template_id": "<string>",
"type": "email",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.
Body
application/json
Response
200 - application/json
Successful Response
Was this page helpful?