Update a topic
curl --request PATCH \
--url https://api.buzzkit.dev/v1/topics/{topicSlug} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"category": "<string>",
"dailyCap": 25,
"channels": [],
"defaultOptedIn": true,
"channelDefaults": {}
}
'import requests
url = "https://api.buzzkit.dev/v1/topics/{topicSlug}"
payload = {
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"category": "<string>",
"dailyCap": 25,
"channels": [],
"defaultOptedIn": True,
"channelDefaults": {}
}
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({
slug: '<string>',
name: '<string>',
description: '<string>',
category: '<string>',
dailyCap: 25,
channels: [],
defaultOptedIn: true,
channelDefaults: {}
})
};
fetch('https://api.buzzkit.dev/v1/topics/{topicSlug}', 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.buzzkit.dev/v1/topics/{topicSlug}",
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([
'slug' => '<string>',
'name' => '<string>',
'description' => '<string>',
'category' => '<string>',
'dailyCap' => 25,
'channels' => [
],
'defaultOptedIn' => true,
'channelDefaults' => [
]
]),
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.buzzkit.dev/v1/topics/{topicSlug}"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"dailyCap\": 25,\n \"channels\": [],\n \"defaultOptedIn\": true,\n \"channelDefaults\": {}\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.buzzkit.dev/v1/topics/{topicSlug}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"dailyCap\": 25,\n \"channels\": [],\n \"defaultOptedIn\": true,\n \"channelDefaults\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.buzzkit.dev/v1/topics/{topicSlug}")
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 \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"dailyCap\": 25,\n \"channels\": [],\n \"defaultOptedIn\": true,\n \"channelDefaults\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {},
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
},
"metadata": {
"timestamp": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}Topics
Update a topic
PATCH
/
v1
/
topics
/
{topicSlug}
Update a topic
curl --request PATCH \
--url https://api.buzzkit.dev/v1/topics/{topicSlug} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"category": "<string>",
"dailyCap": 25,
"channels": [],
"defaultOptedIn": true,
"channelDefaults": {}
}
'import requests
url = "https://api.buzzkit.dev/v1/topics/{topicSlug}"
payload = {
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"category": "<string>",
"dailyCap": 25,
"channels": [],
"defaultOptedIn": True,
"channelDefaults": {}
}
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({
slug: '<string>',
name: '<string>',
description: '<string>',
category: '<string>',
dailyCap: 25,
channels: [],
defaultOptedIn: true,
channelDefaults: {}
})
};
fetch('https://api.buzzkit.dev/v1/topics/{topicSlug}', 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.buzzkit.dev/v1/topics/{topicSlug}",
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([
'slug' => '<string>',
'name' => '<string>',
'description' => '<string>',
'category' => '<string>',
'dailyCap' => 25,
'channels' => [
],
'defaultOptedIn' => true,
'channelDefaults' => [
]
]),
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.buzzkit.dev/v1/topics/{topicSlug}"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"dailyCap\": 25,\n \"channels\": [],\n \"defaultOptedIn\": true,\n \"channelDefaults\": {}\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.buzzkit.dev/v1/topics/{topicSlug}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"dailyCap\": 25,\n \"channels\": [],\n \"defaultOptedIn\": true,\n \"channelDefaults\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.buzzkit.dev/v1/topics/{topicSlug}")
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 \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"dailyCap\": 25,\n \"channels\": [],\n \"defaultOptedIn\": true,\n \"channelDefaults\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {},
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
},
"metadata": {
"timestamp": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}Authorizations
An API key from the dashboard. The scopes listed on each operation are the resource:action grants a key needs (messages:send, subscribers:read, topics:*, *); account:* scopes and key management are session-only. Workspace keys (bk_ws_) reach every tenant and pick one with the buzzkit-tenant header; tenant keys (bk_tn_) are locked to one tenant; client keys (bk_pk_) ship inside an app and only work on /v1/client/*.
Path Parameters
Required string length:
3 - 48Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Required string length:
3 - 48Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Required string length:
1 - 100Maximum string length:
500Maximum string length:
100Required range:
1 <= x <= 50Minimum array length:
1Available options:
push, email Show child attributes
Show child attributes