Skip to main content
PATCH
Update connection
Omitted fields keep their values. Disconnected connections cannot be updated. Requires a user-scoped API key, 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. Some operations also need a key that is associated with a user; their pages say so.

Headers

If-Match
string
required

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

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.

data
object
required