Change alert settings
curl --request PATCH \
--url https://app.lobbystack.com/api/v1/notification-preferences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email_enabled": true,
"sms_enabled": true,
"events": {
"voice_message": {
"email": true,
"sms": true
},
"text_message": {
"email": true,
"sms": true
},
"customer_sms_failed": {
"email": true,
"sms": true
},
"calendar_sync": {
"email": true,
"sms": true
},
"transfer_failed": {
"email": true,
"sms": true
},
"website_chat": {
"email": true,
"sms": true
},
"webhook_disabled": {
"email": true,
"sms": true
}
},
"daily_summary": {
"enabled": true,
"send_time": "<string>"
}
}
'import requests
url = "https://app.lobbystack.com/api/v1/notification-preferences"
payload = {
"email_enabled": True,
"sms_enabled": True,
"events": {
"voice_message": {
"email": True,
"sms": True
},
"text_message": {
"email": True,
"sms": True
},
"customer_sms_failed": {
"email": True,
"sms": True
},
"calendar_sync": {
"email": True,
"sms": True
},
"transfer_failed": {
"email": True,
"sms": True
},
"website_chat": {
"email": True,
"sms": True
},
"webhook_disabled": {
"email": True,
"sms": True
}
},
"daily_summary": {
"enabled": True,
"send_time": "<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({
email_enabled: true,
sms_enabled: true,
events: {
voice_message: {email: true, sms: true},
text_message: {email: true, sms: true},
customer_sms_failed: {email: true, sms: true},
calendar_sync: {email: true, sms: true},
transfer_failed: {email: true, sms: true},
website_chat: {email: true, sms: true},
webhook_disabled: {email: true, sms: true}
},
daily_summary: {enabled: true, send_time: '<string>'}
})
};
fetch('https://app.lobbystack.com/api/v1/notification-preferences', 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://app.lobbystack.com/api/v1/notification-preferences",
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([
'email_enabled' => true,
'sms_enabled' => true,
'events' => [
'voice_message' => [
'email' => true,
'sms' => true
],
'text_message' => [
'email' => true,
'sms' => true
],
'customer_sms_failed' => [
'email' => true,
'sms' => true
],
'calendar_sync' => [
'email' => true,
'sms' => true
],
'transfer_failed' => [
'email' => true,
'sms' => true
],
'website_chat' => [
'email' => true,
'sms' => true
],
'webhook_disabled' => [
'email' => true,
'sms' => true
]
],
'daily_summary' => [
'enabled' => true,
'send_time' => '<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://app.lobbystack.com/api/v1/notification-preferences"
payload := strings.NewReader("{\n \"email_enabled\": true,\n \"sms_enabled\": true,\n \"events\": {\n \"voice_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"text_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"customer_sms_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"calendar_sync\": {\n \"email\": true,\n \"sms\": true\n },\n \"transfer_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"website_chat\": {\n \"email\": true,\n \"sms\": true\n },\n \"webhook_disabled\": {\n \"email\": true,\n \"sms\": true\n }\n },\n \"daily_summary\": {\n \"enabled\": true,\n \"send_time\": \"<string>\"\n }\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://app.lobbystack.com/api/v1/notification-preferences")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email_enabled\": true,\n \"sms_enabled\": true,\n \"events\": {\n \"voice_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"text_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"customer_sms_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"calendar_sync\": {\n \"email\": true,\n \"sms\": true\n },\n \"transfer_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"website_chat\": {\n \"email\": true,\n \"sms\": true\n },\n \"webhook_disabled\": {\n \"email\": true,\n \"sms\": true\n }\n },\n \"daily_summary\": {\n \"enabled\": true,\n \"send_time\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.lobbystack.com/api/v1/notification-preferences")
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 \"email_enabled\": true,\n \"sms_enabled\": true,\n \"events\": {\n \"voice_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"text_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"customer_sms_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"calendar_sync\": {\n \"email\": true,\n \"sms\": true\n },\n \"transfer_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"website_chat\": {\n \"email\": true,\n \"sms\": true\n },\n \"webhook_disabled\": {\n \"email\": true,\n \"sms\": true\n }\n },\n \"daily_summary\": {\n \"enabled\": true,\n \"send_time\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"email_enabled": true,
"sms_enabled": true,
"events": {
"voice_message": {
"email": true,
"sms": true
},
"text_message": {
"email": true,
"sms": true
},
"customer_sms_failed": {
"email": true,
"sms": true
},
"calendar_sync": {
"email": true,
"sms": true
},
"transfer_failed": {
"email": true,
"sms": true
},
"website_chat": {
"email": true,
"sms": true
},
"webhook_disabled": {
"email": true,
"sms": true
}
},
"daily_summary": {
"enabled": true,
"send_time": "<string>"
},
"sms": {
"available": true,
"unavailable_reason": "sender_missing"
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}Notifications
Change alert settings
Changes the fields sent and keeps the rest as saved, including texts the person can’t get right now. Texts need a verified mobile number and the person’s consent to alert texts, which only the dashboard’s notification settings collect: while sms.available is false, turning a text on is a 409, and while it’s true, texts can be turned on here. Turning texts off always works. Values the settings already have change nothing.
PATCH
/
notification-preferences
Change alert settings
curl --request PATCH \
--url https://app.lobbystack.com/api/v1/notification-preferences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email_enabled": true,
"sms_enabled": true,
"events": {
"voice_message": {
"email": true,
"sms": true
},
"text_message": {
"email": true,
"sms": true
},
"customer_sms_failed": {
"email": true,
"sms": true
},
"calendar_sync": {
"email": true,
"sms": true
},
"transfer_failed": {
"email": true,
"sms": true
},
"website_chat": {
"email": true,
"sms": true
},
"webhook_disabled": {
"email": true,
"sms": true
}
},
"daily_summary": {
"enabled": true,
"send_time": "<string>"
}
}
'import requests
url = "https://app.lobbystack.com/api/v1/notification-preferences"
payload = {
"email_enabled": True,
"sms_enabled": True,
"events": {
"voice_message": {
"email": True,
"sms": True
},
"text_message": {
"email": True,
"sms": True
},
"customer_sms_failed": {
"email": True,
"sms": True
},
"calendar_sync": {
"email": True,
"sms": True
},
"transfer_failed": {
"email": True,
"sms": True
},
"website_chat": {
"email": True,
"sms": True
},
"webhook_disabled": {
"email": True,
"sms": True
}
},
"daily_summary": {
"enabled": True,
"send_time": "<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({
email_enabled: true,
sms_enabled: true,
events: {
voice_message: {email: true, sms: true},
text_message: {email: true, sms: true},
customer_sms_failed: {email: true, sms: true},
calendar_sync: {email: true, sms: true},
transfer_failed: {email: true, sms: true},
website_chat: {email: true, sms: true},
webhook_disabled: {email: true, sms: true}
},
daily_summary: {enabled: true, send_time: '<string>'}
})
};
fetch('https://app.lobbystack.com/api/v1/notification-preferences', 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://app.lobbystack.com/api/v1/notification-preferences",
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([
'email_enabled' => true,
'sms_enabled' => true,
'events' => [
'voice_message' => [
'email' => true,
'sms' => true
],
'text_message' => [
'email' => true,
'sms' => true
],
'customer_sms_failed' => [
'email' => true,
'sms' => true
],
'calendar_sync' => [
'email' => true,
'sms' => true
],
'transfer_failed' => [
'email' => true,
'sms' => true
],
'website_chat' => [
'email' => true,
'sms' => true
],
'webhook_disabled' => [
'email' => true,
'sms' => true
]
],
'daily_summary' => [
'enabled' => true,
'send_time' => '<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://app.lobbystack.com/api/v1/notification-preferences"
payload := strings.NewReader("{\n \"email_enabled\": true,\n \"sms_enabled\": true,\n \"events\": {\n \"voice_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"text_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"customer_sms_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"calendar_sync\": {\n \"email\": true,\n \"sms\": true\n },\n \"transfer_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"website_chat\": {\n \"email\": true,\n \"sms\": true\n },\n \"webhook_disabled\": {\n \"email\": true,\n \"sms\": true\n }\n },\n \"daily_summary\": {\n \"enabled\": true,\n \"send_time\": \"<string>\"\n }\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://app.lobbystack.com/api/v1/notification-preferences")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email_enabled\": true,\n \"sms_enabled\": true,\n \"events\": {\n \"voice_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"text_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"customer_sms_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"calendar_sync\": {\n \"email\": true,\n \"sms\": true\n },\n \"transfer_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"website_chat\": {\n \"email\": true,\n \"sms\": true\n },\n \"webhook_disabled\": {\n \"email\": true,\n \"sms\": true\n }\n },\n \"daily_summary\": {\n \"enabled\": true,\n \"send_time\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.lobbystack.com/api/v1/notification-preferences")
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 \"email_enabled\": true,\n \"sms_enabled\": true,\n \"events\": {\n \"voice_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"text_message\": {\n \"email\": true,\n \"sms\": true\n },\n \"customer_sms_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"calendar_sync\": {\n \"email\": true,\n \"sms\": true\n },\n \"transfer_failed\": {\n \"email\": true,\n \"sms\": true\n },\n \"website_chat\": {\n \"email\": true,\n \"sms\": true\n },\n \"webhook_disabled\": {\n \"email\": true,\n \"sms\": true\n }\n },\n \"daily_summary\": {\n \"enabled\": true,\n \"send_time\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"email_enabled": true,
"sms_enabled": true,
"events": {
"voice_message": {
"email": true,
"sms": true
},
"text_message": {
"email": true,
"sms": true
},
"customer_sms_failed": {
"email": true,
"sms": true
},
"calendar_sync": {
"email": true,
"sms": true
},
"transfer_failed": {
"email": true,
"sms": true
},
"website_chat": {
"email": true,
"sms": true
},
"webhook_disabled": {
"email": true,
"sms": true
}
},
"daily_summary": {
"enabled": true,
"send_time": "<string>"
},
"sms": {
"available": true,
"unavailable_reason": "sender_missing"
}
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}Autorisations
An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create. Only platform keys can hold businesses:create and users:create.
En-têtes
The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.
Corps
application/json
Réponse
OK
The alerts the account the key acts as gets about this business. Each person on the team has their own.
Show child attributes
Show child attributes
⌘I