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}

Update connector by ID

cURL

curl --request PUT \
  --url https://api.bigdata.com/contents/v1/connectors/{connector_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data @- <<EOF
{
  "label": "Broker Research - Daily Reports",
  "description": "Collects daily reports from the broker's research team",
  "share_with_org": true,
  "config": {
    "allowed_emails": [
      "[e-mail]",
      "[e-mail]"
    ]
  }
}
EOF

200

{
  "connector_id": "019c4c5c-b021-7a72-8651-53e01b8f9334",
  "user_id": "user_id_001",
  "org_id": "org_id_001",
  "share_with_org": true,
  "label": "Broker Research - Daily Reports",
  "type": "email",
  "description": "Collects daily reports from the broker's research team",
  "config": {
    "allowed_emails": [
      "[e-mail]",
      "[e-mail]"
    ]
  },
  "created_at": "2026-02-11T11:01:09.574095Z",
  "updated_at": "2026-02-11T11:15:30.123456Z",
  "archived": false
}

Authorizations

X-API-KEY · string · header · required

Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.

Path Parameters

connector_id · string<uuid> · required

UUID of the connector to update.

Example:

"019a9612-bfad-758c-884e-37dd8c6ad2cb"

Body

application/json

Payload for PUT /contents/v1/connectors/{connector_id}. Only email accepts a config body; for investment_research and sharepoint, omit config.

label · string · required

New display name for the connector. Required.

Example:

"Broker Research - Daily Reports"

description · string · default: ""

New optional description.

Example:

"Collects daily reports from the broker's research team"

share_with_org · boolean · default: false

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

Example:

true

config · Email · object · null · null

Connector-specific configuration. The structure depends on the connector type.

Show child attributes

Response

200

application/json

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

An ingestion source (e.g. email inbox, investment research / broker feed, or Microsoft SharePoint). Returned by Create/Get/Update connector and List connectors.

connector_id · string<uuid> · required

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

Example:

"019a9612-bfad-758c-884e-37dd8c6ad2cb"

user_id · string · required

ID of the user who owns the connector.

Example:

"user_id_001"

org_id · string · required

ID of the organization the connector belongs to.

Example:

"org_id_001"

share_with_org · boolean · required

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

Example:

true

label · string · required

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

Example:

"Broker Research - Daily Reports"

type · enum<string> · required

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

Available options: email, investment_research, sharepoint

created_at · string<date-time> · required

Timestamp when the connector was created.

Example:

"2026-02-11T11:01:09.574095Z"

updated_at · string<date-time> · required

Timestamp when the connector was last updated.

Example:

"2026-02-11T11:01:09.574102Z"

archived · boolean · required

Whether the connector is archived.

Example:

false

description · string

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

Example:

"Collects daily reports from the broker's research team"

enrichments · enum<string>[]

Enrichments applied to content ingested through this connector. Each value adds a step to the processing pipeline.

Supported enrichments:

• reporting_entities: Identifies the document's reporting company, using the same concept as the ReportingEntity reporting detail in Search. This keeps the reporting entity consistent with the rest of the Bigdata corpus, so you can reliably filter private content, transcripts and filings together.
• translation: Translates the document content so non-English material can be searched and analyzed alongside the rest of your corpus. Supports more than 70 languages.

Available options: reporting_entities, translation

Example:

["translation"]

config · Email · object

Type-specific settings. Email connectors return inbox and allowed senders; investment research connectors return user_id only (never user_password); SharePoint connectors return config as {}.

Email

Investment research

SharePoint

Show child attributes

files_count · integer

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

Example:

10

last_sync_at · string<date-time> | null

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

Example:

"2026-04-07T09:36:34.195040Z"

last_sync_status · string | null

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

Example:

"SUCCESS"

last_sync_error_msg · string | null

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

Example:

null

last_sync_count · integer | null

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

Example:

3200