Update a sync source and its page selection
curl --request PATCH \
--url https://api.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"source_url": "<string>",
"configuration": {
"title": "<string>",
"crawl_mode": "single",
"selection_mode": "selected",
"included_urls": [
"<string>"
]
},
"trusted_auto_publish": true
}
'import requests
url = "https://api.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}"
payload = {
"name": "<string>",
"source_url": "<string>",
"configuration": {
"title": "<string>",
"crawl_mode": "single",
"selection_mode": "selected",
"included_urls": ["<string>"]
},
"trusted_auto_publish": True
}
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>',
source_url: '<string>',
configuration: {
title: '<string>',
crawl_mode: 'single',
selection_mode: 'selected',
included_urls: ['<string>']
},
trusted_auto_publish: true
})
};
fetch('https://api.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}', 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.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}",
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>',
'source_url' => '<string>',
'configuration' => [
'title' => '<string>',
'crawl_mode' => 'single',
'selection_mode' => 'selected',
'included_urls' => [
'<string>'
]
],
'trusted_auto_publish' => true
]),
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.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"source_url\": \"<string>\",\n \"configuration\": {\n \"title\": \"<string>\",\n \"crawl_mode\": \"single\",\n \"selection_mode\": \"selected\",\n \"included_urls\": [\n \"<string>\"\n ]\n },\n \"trusted_auto_publish\": true\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.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"source_url\": \"<string>\",\n \"configuration\": {\n \"title\": \"<string>\",\n \"crawl_mode\": \"single\",\n \"selection_mode\": \"selected\",\n \"included_urls\": [\n \"<string>\"\n ]\n },\n \"trusted_auto_publish\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}")
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 \"source_url\": \"<string>\",\n \"configuration\": {\n \"title\": \"<string>\",\n \"crawl_mode\": \"single\",\n \"selection_mode\": \"selected\",\n \"included_urls\": [\n \"<string>\"\n ]\n },\n \"trusted_auto_publish\": true\n}"
response = http.request(request)
puts response.read_body{
"data": "<unknown>",
"meta": {
"request_id": "<string>",
"next_cursor": "<string>"
}
}Update a sync source and its page selection
PATCH
/
workspaces
/
{workspace}
/
knowledge-lists
/
{list}
/
sources
/
{source}
Update a sync source and its page selection
curl --request PATCH \
--url https://api.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"source_url": "<string>",
"configuration": {
"title": "<string>",
"crawl_mode": "single",
"selection_mode": "selected",
"included_urls": [
"<string>"
]
},
"trusted_auto_publish": true
}
'import requests
url = "https://api.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}"
payload = {
"name": "<string>",
"source_url": "<string>",
"configuration": {
"title": "<string>",
"crawl_mode": "single",
"selection_mode": "selected",
"included_urls": ["<string>"]
},
"trusted_auto_publish": True
}
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>',
source_url: '<string>',
configuration: {
title: '<string>',
crawl_mode: 'single',
selection_mode: 'selected',
included_urls: ['<string>']
},
trusted_auto_publish: true
})
};
fetch('https://api.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}', 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.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}",
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>',
'source_url' => '<string>',
'configuration' => [
'title' => '<string>',
'crawl_mode' => 'single',
'selection_mode' => 'selected',
'included_urls' => [
'<string>'
]
],
'trusted_auto_publish' => true
]),
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.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"source_url\": \"<string>\",\n \"configuration\": {\n \"title\": \"<string>\",\n \"crawl_mode\": \"single\",\n \"selection_mode\": \"selected\",\n \"included_urls\": [\n \"<string>\"\n ]\n },\n \"trusted_auto_publish\": true\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.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"source_url\": \"<string>\",\n \"configuration\": {\n \"title\": \"<string>\",\n \"crawl_mode\": \"single\",\n \"selection_mode\": \"selected\",\n \"included_urls\": [\n \"<string>\"\n ]\n },\n \"trusted_auto_publish\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactbutton.com/v1/workspaces/{workspace}/knowledge-lists/{list}/sources/{source}")
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 \"source_url\": \"<string>\",\n \"configuration\": {\n \"title\": \"<string>\",\n \"crawl_mode\": \"single\",\n \"selection_mode\": \"selected\",\n \"included_urls\": [\n \"<string>\"\n ]\n },\n \"trusted_auto_publish\": true\n}"
response = http.request(request)
puts response.read_body{
"data": "<unknown>",
"meta": {
"request_id": "<string>",
"next_cursor": "<string>"
}
}Authorizations
A Contact Button scoped bearer key. Send Authorization: Bearer <token>.
Token abilities are enforced independently of workspace membership; both checks must pass.
Interactive MCP clients use registered OAuth applications, Authorization Code + PKCE,
audience-bound tokens, and explicit workspace grants. Personal Sanctum tokens remain supported.
Body
application/json
Was this page helpful?