Patch Integration
Apply a shallow update to an existing integration row.
Only fields present in the body are touched. Slug is sticky on
rename so existing references stay valid. Inner integration
is replaced wholesale when provided.
curl --request PATCH \
--url https://api.example.com/admin/api/v1/integrations/{integration_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"enabled": true,
"integration": {
"config": {
"accessToken": "<string>",
"phoneNumberId": "<string>",
"verifyToken": "<string>",
"apiVersion": "v21.0"
},
"enabled": true
}
}
'import requests
url = "https://api.example.com/admin/api/v1/integrations/{integration_id}"
payload = {
"name": "<string>",
"enabled": True,
"integration": {
"config": {
"accessToken": "<string>",
"phoneNumberId": "<string>",
"verifyToken": "<string>",
"apiVersion": "v21.0"
},
"enabled": True
}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
enabled: true,
integration: {
config: {
accessToken: '<string>',
phoneNumberId: '<string>',
verifyToken: '<string>',
apiVersion: 'v21.0'
},
enabled: true
}
})
};
fetch('https://api.example.com/admin/api/v1/integrations/{integration_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.example.com/admin/api/v1/integrations/{integration_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([
'name' => '<string>',
'enabled' => true,
'integration' => [
'config' => [
'accessToken' => '<string>',
'phoneNumberId' => '<string>',
'verifyToken' => '<string>',
'apiVersion' => 'v21.0'
],
'enabled' => true
]
]),
CURLOPT_HTTPHEADER => [
"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.example.com/admin/api/v1/integrations/{integration_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"integration\": {\n \"config\": {\n \"accessToken\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"verifyToken\": \"<string>\",\n \"apiVersion\": \"v21.0\"\n },\n \"enabled\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.example.com/admin/api/v1/integrations/{integration_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"integration\": {\n \"config\": {\n \"accessToken\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"verifyToken\": \"<string>\",\n \"apiVersion\": \"v21.0\"\n },\n \"enabled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/api/v1/integrations/{integration_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"integration\": {\n \"config\": {\n \"accessToken\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"verifyToken\": \"<string>\",\n \"apiVersion\": \"v21.0\"\n },\n \"enabled\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"enabled": true,
"integration": {
"config": {
"accessToken": "<string>",
"phoneNumberId": "<string>",
"verifyToken": "<string>",
"apiVersion": "v21.0"
},
"enabled": true
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"reload": {
"message": "<string>",
"error": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Path Parameters
Body
Body for PATCH /admin/api/v1/integrations/{id}.
The row-level enabled is the single source of truth at assembly;
the inner IntegrationConfig.enabled field is ignored and
overwritten at assembly time (Phase 4+).
Response
Successful Response
GET response and the data payload of POST/PATCH/DELETE responses.
Show child attributes
Show child attributes
Reload outcome attached to every admin mutation response.
reloaded means DB committed and runtime now uses the new config.
restart_required means DB committed and process restart is needed.
reload_failed means DB rolled back and runtime is unchanged.
Show child attributes
Show child attributes
Was this page helpful?
curl --request PATCH \
--url https://api.example.com/admin/api/v1/integrations/{integration_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"enabled": true,
"integration": {
"config": {
"accessToken": "<string>",
"phoneNumberId": "<string>",
"verifyToken": "<string>",
"apiVersion": "v21.0"
},
"enabled": true
}
}
'import requests
url = "https://api.example.com/admin/api/v1/integrations/{integration_id}"
payload = {
"name": "<string>",
"enabled": True,
"integration": {
"config": {
"accessToken": "<string>",
"phoneNumberId": "<string>",
"verifyToken": "<string>",
"apiVersion": "v21.0"
},
"enabled": True
}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
enabled: true,
integration: {
config: {
accessToken: '<string>',
phoneNumberId: '<string>',
verifyToken: '<string>',
apiVersion: 'v21.0'
},
enabled: true
}
})
};
fetch('https://api.example.com/admin/api/v1/integrations/{integration_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.example.com/admin/api/v1/integrations/{integration_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([
'name' => '<string>',
'enabled' => true,
'integration' => [
'config' => [
'accessToken' => '<string>',
'phoneNumberId' => '<string>',
'verifyToken' => '<string>',
'apiVersion' => 'v21.0'
],
'enabled' => true
]
]),
CURLOPT_HTTPHEADER => [
"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.example.com/admin/api/v1/integrations/{integration_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"integration\": {\n \"config\": {\n \"accessToken\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"verifyToken\": \"<string>\",\n \"apiVersion\": \"v21.0\"\n },\n \"enabled\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.example.com/admin/api/v1/integrations/{integration_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"integration\": {\n \"config\": {\n \"accessToken\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"verifyToken\": \"<string>\",\n \"apiVersion\": \"v21.0\"\n },\n \"enabled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/api/v1/integrations/{integration_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"enabled\": true,\n \"integration\": {\n \"config\": {\n \"accessToken\": \"<string>\",\n \"phoneNumberId\": \"<string>\",\n \"verifyToken\": \"<string>\",\n \"apiVersion\": \"v21.0\"\n },\n \"enabled\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"enabled": true,
"integration": {
"config": {
"accessToken": "<string>",
"phoneNumberId": "<string>",
"verifyToken": "<string>",
"apiVersion": "v21.0"
},
"enabled": true
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"reload": {
"message": "<string>",
"error": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}