Sign in

v1

latestOpenAPI 3.1.02026-07-2268276396.6 KB
Connectors

Update connector by ID

Update an existing connector's label, description, and share_with_org. For email connectors, you may also update config (e.g. allowed_emails). For investment_research and sharepoint connectors, configuration cannot be updated. As a PUT request, required fields follow the schema; leaving out a field can clear or default it. The connector type cannot be changed.

put/contents/v1/connectors/{connector_id}

Path parameters

connector_idstring uuid required
Example:019a9612-bfad-758c-884e-37dd8c6ad2cb

UUID of the connector to update.

Request body

labelstring required

New display name for the connector. Required.

descriptionstring

New optional description.

share_with_orgboolean

If true, all members of your organization can access the processed content. If false, only you can access the processed content.

Example request

{
  "label": "Broker Research - Daily Reports",
  "description": "Collects daily reports from the broker's research team",
  "share_with_org": true,
  "config": {
    "allowed_emails": [
      "user@example.com",
      "admin@example.com"
    ],
    "email_hash": "a1b2c3d4e5f6",
    "email": "connector@bigdata.com"
  }
}

Response

The updated connector. Subsequent ingestion uses the new configuration when applicable.

connector_idstring uuid required

Unique identifier for the connector. Use when updating, deleting, or filtering documents by connector.

user_idstring required

ID of the user who owns the connector.

org_idstring required

ID of the organization the connector belongs to.

share_with_orgboolean required

If true, all members of your organization can access the processed content. If false, only you can access the processed content.

labelstring required

Display name for the connector (e.g. for UI or admin lists).

type'email' | 'investment_research' | 'sharepoint' required

Connector type. Determines the configuration and how content is ingested.

descriptionstring

Optional human-readable description of what the connector is used for.

files_countinteger

Number of files ingested through this connector, when tracked (e.g. investment research sync).

last_sync_atstring date-time nullable

Timestamp of the last sync from the external source, when applicable.

last_sync_statusstring nullable

Outcome of the last sync (e.g. SUCCESS), when applicable.

last_sync_error_msgstring nullable

Error message from the last sync when it failed; null on success.

last_sync_countinteger nullable

Number of items processed in the last sync, when applicable.

created_atstring date-time required

Timestamp when the connector was created.

updated_atstring date-time required

Timestamp when the connector was last updated.

archivedboolean required

Whether the connector is archived.

Example response

{
  "connector_id": "019a9612-bfad-758c-884e-37dd8c6ad2cb",
  "user_id": "user_id_001",
  "org_id": "org_id_001",
  "share_with_org": true,
  "label": "Broker Research - Daily Reports",
  "description": "Collects daily reports from the broker's research team",
  "config": {
    "allowed_emails": [
      "user@example.com",
      "admin@example.com"
    ],
    "email_hash": "a1b2c3d4e5f6",
    "email": "connector@bigdata.com"
  },
  "files_count": 10,
  "last_sync_at": "2026-04-07T09:36:34.195040Z",
  "last_sync_status": "SUCCESS",
  "last_sync_count": 3200,
  "created_at": "2026-02-11T11:01:09.574095Z",
  "updated_at": "2026-02-11T11:01:09.574102Z"
}