Update, pause, resume, or complete a Reddit campaign.
curl --request PATCH \
--url https://api.sigmora.org/v1/reddit-campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"connectedAccountId": "<string>",
"brandBrainId": "<string>",
"objective": "<string>",
"offerUrl": "<string>",
"keywords": [
"<string>"
],
"negativeKeywords": [
"<string>"
],
"caps": {
"maxPostsPerDay": 1,
"maxCommentsPerDay": 5,
"maxActionsPerDay": 6,
"promoRatioPct": 10,
"perSubPostsPerDay": 1
},
"autoReplyOurPosts": false,
"alertEmail": "jsmith@example.com"
}
'import requests
url = "https://api.sigmora.org/v1/reddit-campaigns/{campaignId}"
payload = {
"name": "<string>",
"connectedAccountId": "<string>",
"brandBrainId": "<string>",
"objective": "<string>",
"offerUrl": "<string>",
"keywords": ["<string>"],
"negativeKeywords": ["<string>"],
"caps": {
"maxPostsPerDay": 1,
"maxCommentsPerDay": 5,
"maxActionsPerDay": 6,
"promoRatioPct": 10,
"perSubPostsPerDay": 1
},
"autoReplyOurPosts": False,
"alertEmail": "jsmith@example.com"
}
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({
name: '<string>',
connectedAccountId: '<string>',
brandBrainId: '<string>',
objective: '<string>',
offerUrl: '<string>',
keywords: ['<string>'],
negativeKeywords: ['<string>'],
caps: {
maxPostsPerDay: 1,
maxCommentsPerDay: 5,
maxActionsPerDay: 6,
promoRatioPct: 10,
perSubPostsPerDay: 1
},
autoReplyOurPosts: false,
alertEmail: 'jsmith@example.com'
})
};
fetch('https://api.sigmora.org/v1/reddit-campaigns/{campaignId}', 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.sigmora.org/v1/reddit-campaigns/{campaignId}",
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([
'name' => '<string>',
'connectedAccountId' => '<string>',
'brandBrainId' => '<string>',
'objective' => '<string>',
'offerUrl' => '<string>',
'keywords' => [
'<string>'
],
'negativeKeywords' => [
'<string>'
],
'caps' => [
'maxPostsPerDay' => 1,
'maxCommentsPerDay' => 5,
'maxActionsPerDay' => 6,
'promoRatioPct' => 10,
'perSubPostsPerDay' => 1
],
'autoReplyOurPosts' => false,
'alertEmail' => 'jsmith@example.com'
]),
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.sigmora.org/v1/reddit-campaigns/{campaignId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"connectedAccountId\": \"<string>\",\n \"brandBrainId\": \"<string>\",\n \"objective\": \"<string>\",\n \"offerUrl\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"negativeKeywords\": [\n \"<string>\"\n ],\n \"caps\": {\n \"maxPostsPerDay\": 1,\n \"maxCommentsPerDay\": 5,\n \"maxActionsPerDay\": 6,\n \"promoRatioPct\": 10,\n \"perSubPostsPerDay\": 1\n },\n \"autoReplyOurPosts\": false,\n \"alertEmail\": \"jsmith@example.com\"\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.sigmora.org/v1/reddit-campaigns/{campaignId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"connectedAccountId\": \"<string>\",\n \"brandBrainId\": \"<string>\",\n \"objective\": \"<string>\",\n \"offerUrl\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"negativeKeywords\": [\n \"<string>\"\n ],\n \"caps\": {\n \"maxPostsPerDay\": 1,\n \"maxCommentsPerDay\": 5,\n \"maxActionsPerDay\": 6,\n \"promoRatioPct\": 10,\n \"perSubPostsPerDay\": 1\n },\n \"autoReplyOurPosts\": false,\n \"alertEmail\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmora.org/v1/reddit-campaigns/{campaignId}")
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 \"name\": \"<string>\",\n \"connectedAccountId\": \"<string>\",\n \"brandBrainId\": \"<string>\",\n \"objective\": \"<string>\",\n \"offerUrl\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"negativeKeywords\": [\n \"<string>\"\n ],\n \"caps\": {\n \"maxPostsPerDay\": 1,\n \"maxCommentsPerDay\": 5,\n \"maxActionsPerDay\": 6,\n \"promoRatioPct\": 10,\n \"perSubPostsPerDay\": 1\n },\n \"autoReplyOurPosts\": false,\n \"alertEmail\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"campaign": {
"id": "<string>",
"name": "<string>",
"connectedAccountId": "<string>",
"objective": "<string>",
"keywords": [
"<string>"
],
"targetSubreddits": [
{}
],
"caps": {
"maxPostsPerDay": 1,
"maxCommentsPerDay": 5,
"maxActionsPerDay": 6,
"promoRatioPct": 10,
"perSubPostsPerDay": 1
},
"autoReplyOurPosts": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"agentId": "<string>",
"brandBrainId": "<string>",
"offerUrl": "<string>",
"smartLinkId": "<string>",
"negativeKeywords": [
"<string>"
],
"accountReadiness": {},
"activity": {},
"weeklyPlan": {},
"metrics": {},
"marketingCampaignId": "<string>",
"marketingLibraryVersion": "<string>",
"marketingManifest": {}
}
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}API Reference
Update, pause, resume, or complete a Reddit campaign.
PATCH
/
v1
/
reddit-campaigns
/
{campaignId}
Update, pause, resume, or complete a Reddit campaign.
curl --request PATCH \
--url https://api.sigmora.org/v1/reddit-campaigns/{campaignId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"connectedAccountId": "<string>",
"brandBrainId": "<string>",
"objective": "<string>",
"offerUrl": "<string>",
"keywords": [
"<string>"
],
"negativeKeywords": [
"<string>"
],
"caps": {
"maxPostsPerDay": 1,
"maxCommentsPerDay": 5,
"maxActionsPerDay": 6,
"promoRatioPct": 10,
"perSubPostsPerDay": 1
},
"autoReplyOurPosts": false,
"alertEmail": "jsmith@example.com"
}
'import requests
url = "https://api.sigmora.org/v1/reddit-campaigns/{campaignId}"
payload = {
"name": "<string>",
"connectedAccountId": "<string>",
"brandBrainId": "<string>",
"objective": "<string>",
"offerUrl": "<string>",
"keywords": ["<string>"],
"negativeKeywords": ["<string>"],
"caps": {
"maxPostsPerDay": 1,
"maxCommentsPerDay": 5,
"maxActionsPerDay": 6,
"promoRatioPct": 10,
"perSubPostsPerDay": 1
},
"autoReplyOurPosts": False,
"alertEmail": "jsmith@example.com"
}
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({
name: '<string>',
connectedAccountId: '<string>',
brandBrainId: '<string>',
objective: '<string>',
offerUrl: '<string>',
keywords: ['<string>'],
negativeKeywords: ['<string>'],
caps: {
maxPostsPerDay: 1,
maxCommentsPerDay: 5,
maxActionsPerDay: 6,
promoRatioPct: 10,
perSubPostsPerDay: 1
},
autoReplyOurPosts: false,
alertEmail: 'jsmith@example.com'
})
};
fetch('https://api.sigmora.org/v1/reddit-campaigns/{campaignId}', 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.sigmora.org/v1/reddit-campaigns/{campaignId}",
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([
'name' => '<string>',
'connectedAccountId' => '<string>',
'brandBrainId' => '<string>',
'objective' => '<string>',
'offerUrl' => '<string>',
'keywords' => [
'<string>'
],
'negativeKeywords' => [
'<string>'
],
'caps' => [
'maxPostsPerDay' => 1,
'maxCommentsPerDay' => 5,
'maxActionsPerDay' => 6,
'promoRatioPct' => 10,
'perSubPostsPerDay' => 1
],
'autoReplyOurPosts' => false,
'alertEmail' => 'jsmith@example.com'
]),
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.sigmora.org/v1/reddit-campaigns/{campaignId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"connectedAccountId\": \"<string>\",\n \"brandBrainId\": \"<string>\",\n \"objective\": \"<string>\",\n \"offerUrl\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"negativeKeywords\": [\n \"<string>\"\n ],\n \"caps\": {\n \"maxPostsPerDay\": 1,\n \"maxCommentsPerDay\": 5,\n \"maxActionsPerDay\": 6,\n \"promoRatioPct\": 10,\n \"perSubPostsPerDay\": 1\n },\n \"autoReplyOurPosts\": false,\n \"alertEmail\": \"jsmith@example.com\"\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.sigmora.org/v1/reddit-campaigns/{campaignId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"connectedAccountId\": \"<string>\",\n \"brandBrainId\": \"<string>\",\n \"objective\": \"<string>\",\n \"offerUrl\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"negativeKeywords\": [\n \"<string>\"\n ],\n \"caps\": {\n \"maxPostsPerDay\": 1,\n \"maxCommentsPerDay\": 5,\n \"maxActionsPerDay\": 6,\n \"promoRatioPct\": 10,\n \"perSubPostsPerDay\": 1\n },\n \"autoReplyOurPosts\": false,\n \"alertEmail\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sigmora.org/v1/reddit-campaigns/{campaignId}")
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 \"name\": \"<string>\",\n \"connectedAccountId\": \"<string>\",\n \"brandBrainId\": \"<string>\",\n \"objective\": \"<string>\",\n \"offerUrl\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"negativeKeywords\": [\n \"<string>\"\n ],\n \"caps\": {\n \"maxPostsPerDay\": 1,\n \"maxCommentsPerDay\": 5,\n \"maxActionsPerDay\": 6,\n \"promoRatioPct\": 10,\n \"perSubPostsPerDay\": 1\n },\n \"autoReplyOurPosts\": false,\n \"alertEmail\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"campaign": {
"id": "<string>",
"name": "<string>",
"connectedAccountId": "<string>",
"objective": "<string>",
"keywords": [
"<string>"
],
"targetSubreddits": [
{}
],
"caps": {
"maxPostsPerDay": 1,
"maxCommentsPerDay": 5,
"maxActionsPerDay": 6,
"promoRatioPct": 10,
"perSubPostsPerDay": 1
},
"autoReplyOurPosts": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"agentId": "<string>",
"brandBrainId": "<string>",
"offerUrl": "<string>",
"smartLinkId": "<string>",
"negativeKeywords": [
"<string>"
],
"accountReadiness": {},
"activity": {},
"weeklyPlan": {},
"metrics": {},
"marketingCampaignId": "<string>",
"marketingLibraryVersion": "<string>",
"marketingManifest": {}
}
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}{
"success": "<unknown>",
"error": "<string>",
"details": "<unknown>"
}Authorizations
A workspace API key.
Path Parameters
Required string length:
1 - 200Body
application/json
Required string length:
1 - 120Required string length:
1 - 200Required string length:
1 - 200Required string length:
1 - 2000Required array length:
1 - 25 elementsRequired string length:
1 - 80Maximum array length:
25Required string length:
1 - 80Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Available options:
active, paused, completed ⌘I