curl --request PATCH \
--url https://api.adapter.com/v1/custom-connectors/{connector_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"accepted_kinds": [
"<string>"
],
"metadata": {
"env": "staging"
},
"is_active": true
}
'import requests
url = "https://api.adapter.com/v1/custom-connectors/{connector_id}"
payload = {
"name": "<string>",
"accepted_kinds": ["<string>"],
"metadata": { "env": "staging" },
"is_active": 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>',
accepted_kinds: ['<string>'],
metadata: {env: 'staging'},
is_active: true
})
};
fetch('https://api.adapter.com/v1/custom-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.adapter.com/v1/custom-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([
'name' => '<string>',
'accepted_kinds' => [
'<string>'
],
'metadata' => [
'env' => 'staging'
],
'is_active' => 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.adapter.com/v1/custom-connectors/{connector_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"accepted_kinds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"env\": \"staging\"\n },\n \"is_active\": 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.adapter.com/v1/custom-connectors/{connector_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"accepted_kinds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"env\": \"staging\"\n },\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adapter.com/v1/custom-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 \"name\": \"<string>\",\n \"accepted_kinds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"env\": \"staging\"\n },\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"connector_id": "c0ffee01-1234-5678-90ab-cdef01234567",
"name": "Acme CRM",
"source_name": "acme-crm",
"created_at": "<string>",
"created_by": {
"type": "user",
"id": "u_01abc123"
},
"is_active": true,
"accepted_kinds": [
"email",
"page"
],
"metadata": {
"env": "staging"
}
}{
"error_code": "authentication_error",
"message": "Invalid or missing credentials.",
"details": {}
}{
"error_code": "permission_denied",
"message": "You do not have permission to perform this action.",
"details": {}
}{
"message": "<string>",
"error_code": "client_not_found",
"details": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error_code": "internal_server_error",
"message": "An unexpected error occurred.",
"details": {}
}Update a custom connector
Update mutable fields on a connector. source_name is immutable.
curl --request PATCH \
--url https://api.adapter.com/v1/custom-connectors/{connector_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"accepted_kinds": [
"<string>"
],
"metadata": {
"env": "staging"
},
"is_active": true
}
'import requests
url = "https://api.adapter.com/v1/custom-connectors/{connector_id}"
payload = {
"name": "<string>",
"accepted_kinds": ["<string>"],
"metadata": { "env": "staging" },
"is_active": 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>',
accepted_kinds: ['<string>'],
metadata: {env: 'staging'},
is_active: true
})
};
fetch('https://api.adapter.com/v1/custom-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.adapter.com/v1/custom-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([
'name' => '<string>',
'accepted_kinds' => [
'<string>'
],
'metadata' => [
'env' => 'staging'
],
'is_active' => 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.adapter.com/v1/custom-connectors/{connector_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"accepted_kinds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"env\": \"staging\"\n },\n \"is_active\": 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.adapter.com/v1/custom-connectors/{connector_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"accepted_kinds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"env\": \"staging\"\n },\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.adapter.com/v1/custom-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 \"name\": \"<string>\",\n \"accepted_kinds\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"env\": \"staging\"\n },\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"connector_id": "c0ffee01-1234-5678-90ab-cdef01234567",
"name": "Acme CRM",
"source_name": "acme-crm",
"created_at": "<string>",
"created_by": {
"type": "user",
"id": "u_01abc123"
},
"is_active": true,
"accepted_kinds": [
"email",
"page"
],
"metadata": {
"env": "staging"
}
}{
"error_code": "authentication_error",
"message": "Invalid or missing credentials.",
"details": {}
}{
"error_code": "permission_denied",
"message": "You do not have permission to perform this action.",
"details": {}
}{
"message": "<string>",
"error_code": "client_not_found",
"details": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error_code": "internal_server_error",
"message": "An unexpected error occurred.",
"details": {}
}Authorizations
Pass your pk_live_... API key as a Bearer token.
Path Parameters
Body
Response
Successful Response
Unique identifier for the connector.
"c0ffee01-1234-5678-90ab-cdef01234567"
Human display name.
"Acme CRM"
Immutable slug used in the event source (custom:<source_name>).
"acme-crm"
ISO 8601 creation timestamp.
Principal that created a resource. id is a user_id for type="user"
and a key_id (UUID) for type="api_key".
Show child attributes
Show child attributes
False once the connector has been deactivated.
First-party event kinds this connector may emit. Empty = all kinds allowed.
["email", "page"]
Key/value metadata applied to every event from this connector. String values only. Per-item metadata on ingest overrides on key conflict.
Show child attributes
Show child attributes
{ "env": "staging" }
Was this page helpful?