curl --request PATCH \
--url https://api.indices.io/v1beta/connectors/{connector_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "Invoice retrieval"
}
'import requests
url = "https://api.indices.io/v1beta/connectors/{connector_id}"
payload = { "display_name": "Invoice retrieval" }
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({display_name: 'Invoice retrieval'})
};
fetch('https://api.indices.io/v1beta/connectors/{connector_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.indices.io/v1beta/connectors/{connector_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([
'display_name' => 'Invoice retrieval'
]),
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.indices.io/v1beta/connectors/{connector_id}"
payload := strings.NewReader("{\n \"display_name\": \"Invoice retrieval\"\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.indices.io/v1beta/connectors/{connector_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"Invoice retrieval\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.indices.io/v1beta/connectors/{connector_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 \"display_name\": \"Invoice retrieval\"\n}"
response = http.request(request)
puts response.read_body{
"id": "conn_8kPq2mWxYz1aBcDeFgHi3J",
"display_name": "Invoice retrieval",
"purpose": "Retrieve invoices from our ERP system, including refunds.",
"website": "https://example.com",
"input_schema": {},
"output_schema": {},
"revised_from_connector_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"required_secrets": [
{
"name": "amazon_login",
"type": "login",
"supports_totp": false,
"description": "Amazon account whose orders are fetched."
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Rename a connector
Rename a connector by updating its display name. The connector ID is unchanged.
curl --request PATCH \
--url https://api.indices.io/v1beta/connectors/{connector_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "Invoice retrieval"
}
'import requests
url = "https://api.indices.io/v1beta/connectors/{connector_id}"
payload = { "display_name": "Invoice retrieval" }
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({display_name: 'Invoice retrieval'})
};
fetch('https://api.indices.io/v1beta/connectors/{connector_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.indices.io/v1beta/connectors/{connector_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([
'display_name' => 'Invoice retrieval'
]),
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.indices.io/v1beta/connectors/{connector_id}"
payload := strings.NewReader("{\n \"display_name\": \"Invoice retrieval\"\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.indices.io/v1beta/connectors/{connector_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"Invoice retrieval\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.indices.io/v1beta/connectors/{connector_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 \"display_name\": \"Invoice retrieval\"\n}"
response = http.request(request)
puts response.read_body{
"id": "conn_8kPq2mWxYz1aBcDeFgHi3J",
"display_name": "Invoice retrieval",
"purpose": "Retrieve invoices from our ERP system, including refunds.",
"website": "https://example.com",
"input_schema": {},
"output_schema": {},
"revised_from_connector_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"required_secrets": [
{
"name": "amazon_login",
"type": "login",
"supports_totp": false,
"description": "Amazon account whose orders are fetched."
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Enter your API key as the bearer token. Set header: Authorization to Bearer <api_key>
Path Parameters
The ID of the connector to rename.
Body
Short human-readable name of the connector.
1 - 200"Invoice retrieval"
Response
Successful response
Unique identifier for the object.
"conn_8kPq2mWxYz1aBcDeFgHi3J"
Short human-readable name of the connector.
"Invoice retrieval"
What the connector does, as specified at publish time.
"Retrieve invoices from our ERP system, including refunds."
Website the connector operates against.
"https://example.com"
JSON Schema for the connector's run arguments.
JSON Schema for the connector's run results.
Connector this one revised (if any).
Timestamp when the object was created.
Secret slots that must be bound when running the connector.
Show child attributes
Show child attributes