Skip to main content
PATCH
/
v1
/
custom-connectors
/
{connector_id}
Update a custom connector
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
}
'
{
  "connector_id": "<string>",
  "name": "<string>",
  "source_name": "<string>",
  "created_at": "<string>",
  "created_by": {
    "id": "<string>"
  },
  "is_active": true,
  "accepted_kinds": [
    "<string>"
  ],
  "metadata": {
    "env": "staging"
  }
}

Authorizations

​
Authorization
string
header
required

Pass your pk_live_... API key as a Bearer token.

Path Parameters

​
connector_id
string
required

Body

application/json
​
name
string | null
Required string length: 1 - 255
​
accepted_kinds
string[] | null
​
metadata
Metadata · object

Replaces the connector's metadata. String values only. Applies to events ingested after the patch.

Example:
{ "env": "staging" }
​
is_active
boolean | null

Response

Successful Response

​
connector_id
string
required

Unique identifier for the connector.

Example:

"c0ffee01-1234-5678-90ab-cdef01234567"

​
name
string
required

Human display name.

Example:

"Acme CRM"

​
source_name
string
required

Immutable slug used in the event source (custom:<source_name>).

Example:

"acme-crm"

​
created_at
string
required

ISO 8601 creation timestamp.

​
created_by
CreatedBy · object
required

Principal that created a resource. id is a user_id for type="user" and a key_id (UUID) for type="api_key".

​
is_active
boolean
required

False once the connector has been deactivated.

​
accepted_kinds
string[]

First-party event kinds this connector may emit. Empty = all kinds allowed.

Example:
["email", "page"]
​
metadata
Metadata · object

Key/value metadata applied to every event from this connector. String values only. Per-item metadata on ingest overrides on key conflict.

Example:
{ "env": "staging" }