Skip to main content
PATCH
Update connection
Omitted fields keep their values. Disconnected connections cannot be updated. Requires an API key with an owner, and write:gl for a general-ledger connection or write:connections for other connections. A general-ledger connection supports one legal entity. NetSuite rejects an ambiguous configuration with HTTP 409. Exchange, bank and card connections accept an optional If-Match with the etag of the connection. A changed connection returns HTTP 412. The check is not atomic with the provider call. General-ledger connections ignore If-Match.

Authorizations

X-API-Key
string
header
required

Your organization API key. See Authentication.

Headers

If-Match
string

Optional. The etag from List connections. A stale value returns HTTP 412.

Idempotency-Key
string

Optional retry key. Check X-Idempotency-Applied before relying on replay protection.

Required string length: 1 - 255

Path Parameters

connection_id
string
required

ID of the connection.

Minimum string length: 1

Body

application/json
name
string

Display name.

Required string length: 1 - 500
Example:

"Operating bank connection"

Legal entities (le_…).

Maximum array length: 100

Legal entity ID (le_…).

Response

The request succeeded.

id
string
required

Connection ID (con_…).

Example:

"con_507f1f77bcf86cd799439011"

organization_id
string
required

Organization ID (org_…).

Example:

"org_507f1f77bcf86cd799439011"

provider
string
required

Provider identifier.

Example:

"quickbooks"

auth_method
enum<string>
required

Setup method.

Available options:
oauth,
api_key
name
string
required

Connection display name.

status
enum<string>
required

Connection status.

Available options:
pending_setup,
active,
expired,
disconnecting,
disconnected,
failed
external_account_id
string | null
required

Account ID at the provider.

Legal entities of the connection (le_…).

Legal entity ID (le_…).

source_ids
string[]
required

Sources created from the connection.

Source ID (src_…).

capabilities
string[]
required

Actions that the connection supports.

Supported action.

created_at
string<date-time>
required

ISO 8601 UTC timestamp.

Example:

"2026-08-31T12:00:00Z"

guidance
object
required
etag
string
required
read-only

Strong version of this resource. Send this value, including its quotes, in If-Match when updating it.

Pattern: ^"[^"\r\n]+"$
Example:

"\"v_example\""

authorization_attempt
object

The latest setup attempt.

revocation_error
string | null

Why the provider did not revoke access. A disabled connection in Entendre does not prove that the provider revoked access.

retained_resources
string[]

Resource types that stay after a disconnect.

Resource types retained after disconnect.

cleanup
object

Present after bank disconnect. Counts rows removed by this call. Zero is valid for empty or already-cleaned connections.

importable_resources
string[]

General-ledger connections only: the resource types that the connection can import.