Skip to main content
PUT
Set business read-only status
While a business is on read-only mode, any mutating request (POST, PUT, PATCH, DELETE) under /v1/businesses/{businessId} is rejected with an HTTP 403 response.
This PUT endpoint is exempt from that rejection. You can always call it to set or clear the flag, including while the business is read-only. Read (GET) requests are unaffected.

Bank connections and reversibility

Enabling read-only mode disconnects the business’s bank connections that are linked through Plaid (the business’s plaid_items) as part of the same request. Clearing the flag restores writes, but it does not reconnect them.
Disconnecting bank connections is irreversible. Clearing read-only mode does not reconnect them.

Response

A successful request returns the full, updated business in data, the same representation returned by Fetch a business. Its readonly field reflects the resulting read-only state.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string

Content-Type must be set to application/json.

Path Parameters

businessId
string
required

The UUID of the business to update.

Body

application/json
readonly
boolean
required

Set to true to enable read-only mode for the business, or false to clear it.

Response

The updated business, reflecting the resulting read-only status.

data
object
required