Update Connection
curl --request PATCH \
--url https://api.pathstack.io/connection/{connection_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"active": true,
"tags": [
"<string>"
],
"business_name": "<string>",
"abn": "<string>",
"email": "jsmith@example.com"
}
'import requests
url = "https://api.pathstack.io/connection/{connection_id}"
payload = {
"active": True,
"tags": ["<string>"],
"business_name": "<string>",
"abn": "<string>",
"email": "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({
active: true,
tags: ['<string>'],
business_name: '<string>',
abn: '<string>',
email: 'jsmith@example.com'
})
};
fetch('https://api.pathstack.io/connection/{connection_id}', 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.pathstack.io/connection/{connection_id}",
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([
'active' => true,
'tags' => [
'<string>'
],
'business_name' => '<string>',
'abn' => '<string>',
'email' => '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.pathstack.io/connection/{connection_id}"
payload := strings.NewReader("{\n \"active\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"business_name\": \"<string>\",\n \"abn\": \"<string>\",\n \"email\": \"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.pathstack.io/connection/{connection_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"business_name\": \"<string>\",\n \"abn\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pathstack.io/connection/{connection_id}")
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 \"active\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"business_name\": \"<string>\",\n \"abn\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"business_name": "<string>",
"abn": "<string>",
"email": "<string>",
"active": true,
"id": "<string>",
"tenant_id": "<string>",
"collection_start_time": "2023-11-07T05:31:56Z",
"collection_end_time": "2023-11-07T05:31:56Z",
"configuration": {},
"connection_tags": []
}
}{
"error": {
"code": 400,
"message": "Invalid JWT format"
}
}{
"error": {
"code": 401,
"message": "Authentication header is missing, or token is invalid/expired."
}
}{
"error": {
"code": 403,
"message": "You do not have access to this resource"
}
}{
"error": {
"code": 404,
"message": "Connection with ID <connection_id> not found"
}
}{
"error": {
"code": 422,
"message": "Field required",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
}Connections
Update Connection
Update connection metadata (active toggle, tag assignment, business_name, abn, email). Only the owning tenant may update a connection.
- Omitting a field leaves it unchanged.
- Sending null or [] for tags clears all tag assignments.
- Sending null for business_name, abn, or email clears that field.
- Sending null for active is not allowed (active is always a bool).
PATCH
/
connection
/
{connection_id}
Update Connection
curl --request PATCH \
--url https://api.pathstack.io/connection/{connection_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"active": true,
"tags": [
"<string>"
],
"business_name": "<string>",
"abn": "<string>",
"email": "jsmith@example.com"
}
'import requests
url = "https://api.pathstack.io/connection/{connection_id}"
payload = {
"active": True,
"tags": ["<string>"],
"business_name": "<string>",
"abn": "<string>",
"email": "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({
active: true,
tags: ['<string>'],
business_name: '<string>',
abn: '<string>',
email: 'jsmith@example.com'
})
};
fetch('https://api.pathstack.io/connection/{connection_id}', 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.pathstack.io/connection/{connection_id}",
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([
'active' => true,
'tags' => [
'<string>'
],
'business_name' => '<string>',
'abn' => '<string>',
'email' => '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.pathstack.io/connection/{connection_id}"
payload := strings.NewReader("{\n \"active\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"business_name\": \"<string>\",\n \"abn\": \"<string>\",\n \"email\": \"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.pathstack.io/connection/{connection_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"active\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"business_name\": \"<string>\",\n \"abn\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pathstack.io/connection/{connection_id}")
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 \"active\": true,\n \"tags\": [\n \"<string>\"\n ],\n \"business_name\": \"<string>\",\n \"abn\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"business_name": "<string>",
"abn": "<string>",
"email": "<string>",
"active": true,
"id": "<string>",
"tenant_id": "<string>",
"collection_start_time": "2023-11-07T05:31:56Z",
"collection_end_time": "2023-11-07T05:31:56Z",
"configuration": {},
"connection_tags": []
}
}{
"error": {
"code": 400,
"message": "Invalid JWT format"
}
}{
"error": {
"code": 401,
"message": "Authentication header is missing, or token is invalid/expired."
}
}{
"error": {
"code": 403,
"message": "You do not have access to this resource"
}
}{
"error": {
"code": 404,
"message": "Connection with ID <connection_id> not found"
}
}{
"error": {
"code": 422,
"message": "Field required",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Connection ID of the Connection to be updated
Body
application/json
Response
Successful Response
Show child attributes
Show child attributes
⌘I

