Update integration
curl --request PATCH \
--url http://localhost:8080/api/v1/integrations/{integration} \
--header 'Content-Type: application/json' \
--cookie __Host-oc_session= \
--data '
{
"name": "<string>",
"configuration": {}
}
'import requests
url = "http://localhost:8080/api/v1/integrations/{integration}"
payload = {
"name": "<string>",
"configuration": {}
}
headers = {
"cookie": "__Host-oc_session=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {cookie: '__Host-oc_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', configuration: {}})
};
fetch('http://localhost:8080/api/v1/integrations/{integration}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/integrations/{integration}",
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>',
'configuration' => [
]
]),
CURLOPT_COOKIE => "__Host-oc_session=",
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 := "http://localhost:8080/api/v1/integrations/{integration}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"configuration\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cookie", "__Host-oc_session=")
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("http://localhost:8080/api/v1/integrations/{integration}")
.header("cookie", "__Host-oc_session=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"configuration\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/integrations/{integration}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["cookie"] = '__Host-oc_session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"configuration\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"name": "<string>",
"status": "verified",
"disabled": true,
"configuration": {},
"toolAvailability": [
{
"tool": "<string>",
"available": true,
"reason": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"relayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"webhook": {
"url": "<string>",
"configured": true
},
"credential": {
"configured": true
},
"verifiedAt": "2023-11-07T05:31:56Z",
"inbound": {
"available": true,
"reason": "<string>"
},
"verificationNote": "<string>"
}{
"error": "the requested resource is not available to this caller",
"reason": "credential_rejected",
"requires": "<string>"
}Integrations
Update integration
PATCH
/
api
/
v1
/
integrations
/
{integration}
Update integration
curl --request PATCH \
--url http://localhost:8080/api/v1/integrations/{integration} \
--header 'Content-Type: application/json' \
--cookie __Host-oc_session= \
--data '
{
"name": "<string>",
"configuration": {}
}
'import requests
url = "http://localhost:8080/api/v1/integrations/{integration}"
payload = {
"name": "<string>",
"configuration": {}
}
headers = {
"cookie": "__Host-oc_session=",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {cookie: '__Host-oc_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', configuration: {}})
};
fetch('http://localhost:8080/api/v1/integrations/{integration}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/integrations/{integration}",
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>',
'configuration' => [
]
]),
CURLOPT_COOKIE => "__Host-oc_session=",
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 := "http://localhost:8080/api/v1/integrations/{integration}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"configuration\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cookie", "__Host-oc_session=")
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("http://localhost:8080/api/v1/integrations/{integration}")
.header("cookie", "__Host-oc_session=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"configuration\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/integrations/{integration}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["cookie"] = '__Host-oc_session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"configuration\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"name": "<string>",
"status": "verified",
"disabled": true,
"configuration": {},
"toolAvailability": [
{
"tool": "<string>",
"available": true,
"reason": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"relayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"webhook": {
"url": "<string>",
"configured": true
},
"credential": {
"configured": true
},
"verifiedAt": "2023-11-07T05:31:56Z",
"inbound": {
"available": true,
"reason": "<string>"
},
"verificationNote": "<string>"
}{
"error": "the requested resource is not available to this caller",
"reason": "credential_rejected",
"requires": "<string>"
}Authorizations
Path Parameters
Response
Integration after an operation, including its immediate verification diagnostic when one ran.
Pattern:
^[a-z][a-z0-9_]{0,63}$Required string length:
1 - 128Available options:
verified, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
1024