Update Square Integration Instance
PUT/api/square/instances/:squareIntegrationInstance
Update a Square integration instance. The manager splits the payload across direct columns (name), connection settings (environment, access_token, merchant_id), and integration settings (order_import_start_date, default_return_warehouse_id).
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Route name: square.instances.update
payments_enabled (boolean, optional) — toggles whether the register offers this Square account as a card tender. Automatically set to true when an OAuth grant includes PAYMENTS_WRITE.
The name must stay unique across all of your integrations. Renaming this instance to a name another integration already uses returns 422 with a NameMustBeUnique error on the name field; keeping its current name always succeeds.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.