Slack Bot Update Options
curl --request PATCH \
--url https://api.hyperspell.com/admin/slack-bot/options \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"digest_channel_id": "<string>",
"digest_hour_utc": 11,
"gamification": true,
"channel_personal_scope": true,
"interject_enabled": true,
"interject_channels": [
"<string>"
],
"capture_emoji": "<string>"
}
'import requests
url = "https://api.hyperspell.com/admin/slack-bot/options"
payload = {
"digest_channel_id": "<string>",
"digest_hour_utc": 11,
"gamification": True,
"channel_personal_scope": True,
"interject_enabled": True,
"interject_channels": ["<string>"],
"capture_emoji": "<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({
digest_channel_id: '<string>',
digest_hour_utc: 11,
gamification: true,
channel_personal_scope: true,
interject_enabled: true,
interject_channels: ['<string>'],
capture_emoji: '<string>'
})
};
fetch('https://api.hyperspell.com/admin/slack-bot/options', 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.hyperspell.com/admin/slack-bot/options",
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([
'digest_channel_id' => '<string>',
'digest_hour_utc' => 11,
'gamification' => true,
'channel_personal_scope' => true,
'interject_enabled' => true,
'interject_channels' => [
'<string>'
],
'capture_emoji' => '<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.hyperspell.com/admin/slack-bot/options"
payload := strings.NewReader("{\n \"digest_channel_id\": \"<string>\",\n \"digest_hour_utc\": 11,\n \"gamification\": true,\n \"channel_personal_scope\": true,\n \"interject_enabled\": true,\n \"interject_channels\": [\n \"<string>\"\n ],\n \"capture_emoji\": \"<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.hyperspell.com/admin/slack-bot/options")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"digest_channel_id\": \"<string>\",\n \"digest_hour_utc\": 11,\n \"gamification\": true,\n \"channel_personal_scope\": true,\n \"interject_enabled\": true,\n \"interject_channels\": [\n \"<string>\"\n ],\n \"capture_emoji\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperspell.com/admin/slack-bot/options")
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 \"digest_channel_id\": \"<string>\",\n \"digest_hour_utc\": 11,\n \"gamification\": true,\n \"channel_personal_scope\": true,\n \"interject_enabled\": true,\n \"interject_channels\": [\n \"<string>\"\n ],\n \"capture_emoji\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"configured": true,
"installed": true,
"viewer_is_owner": false,
"workspace_name": "<string>",
"workspace_id": "<string>",
"installed_at": "<string>",
"healthy": true,
"options": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Slack Bot
Slack Bot Update Options
Merge the provided fields into options.slack_bot on the app’s Slack
IntegrationConfig; returns the refreshed status.
PATCH
/
admin
/
slack-bot
/
options
Slack Bot Update Options
curl --request PATCH \
--url https://api.hyperspell.com/admin/slack-bot/options \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"digest_channel_id": "<string>",
"digest_hour_utc": 11,
"gamification": true,
"channel_personal_scope": true,
"interject_enabled": true,
"interject_channels": [
"<string>"
],
"capture_emoji": "<string>"
}
'import requests
url = "https://api.hyperspell.com/admin/slack-bot/options"
payload = {
"digest_channel_id": "<string>",
"digest_hour_utc": 11,
"gamification": True,
"channel_personal_scope": True,
"interject_enabled": True,
"interject_channels": ["<string>"],
"capture_emoji": "<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({
digest_channel_id: '<string>',
digest_hour_utc: 11,
gamification: true,
channel_personal_scope: true,
interject_enabled: true,
interject_channels: ['<string>'],
capture_emoji: '<string>'
})
};
fetch('https://api.hyperspell.com/admin/slack-bot/options', 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.hyperspell.com/admin/slack-bot/options",
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([
'digest_channel_id' => '<string>',
'digest_hour_utc' => 11,
'gamification' => true,
'channel_personal_scope' => true,
'interject_enabled' => true,
'interject_channels' => [
'<string>'
],
'capture_emoji' => '<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.hyperspell.com/admin/slack-bot/options"
payload := strings.NewReader("{\n \"digest_channel_id\": \"<string>\",\n \"digest_hour_utc\": 11,\n \"gamification\": true,\n \"channel_personal_scope\": true,\n \"interject_enabled\": true,\n \"interject_channels\": [\n \"<string>\"\n ],\n \"capture_emoji\": \"<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.hyperspell.com/admin/slack-bot/options")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"digest_channel_id\": \"<string>\",\n \"digest_hour_utc\": 11,\n \"gamification\": true,\n \"channel_personal_scope\": true,\n \"interject_enabled\": true,\n \"interject_channels\": [\n \"<string>\"\n ],\n \"capture_emoji\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperspell.com/admin/slack-bot/options")
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 \"digest_channel_id\": \"<string>\",\n \"digest_hour_utc\": 11,\n \"gamification\": true,\n \"channel_personal_scope\": true,\n \"interject_enabled\": true,\n \"interject_channels\": [\n \"<string>\"\n ],\n \"capture_emoji\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"configured": true,
"installed": true,
"viewer_is_owner": false,
"workspace_name": "<string>",
"workspace_id": "<string>",
"installed_at": "<string>",
"healthy": true,
"options": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.
Body
application/json
Partial SlackBotOptions update — only provided fields change.
digest_channel_id=None explicitly clears the digest target (turns the
digest off for the app), so absence and null are distinct — hence
exclude_unset at the write site.
Available options:
daily, weekly Required range:
0 <= x <= 23Required string length:
1 - 100Pattern:
^[a-z0-9_+-]+$Was this page helpful?
⌘I