Disable a connector

Turns the connector OFF (sets enabled: false) and returns it (secrets masked). Idempotent — disabling an already-disabled connector is a no-op success. Reversible: the stored config is untouched, so re-enabling restores the connector as configured. 404 on an unknown key. Requires pos.settings.manage.

POST /v1/integrations/{key}/disable

Error

A valid request URL is required to generate request examples

200

{
  "key": "shopify",
  "name": "Shopify",
  "category": "ecommerce",
  "enabled": false,
  "config": {
    "shopDomain": "acme.myshopify.com",
    "accessToken": "••••••",
    "syncStock": true
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Authorizations

Authorization · string · header · required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Path Parameters

key · string · required

Minimum string length: 1

Response

200

application/json

The disabled connector (secrets masked).

The disabled connector (secrets masked).

key · string · required

Minimum string length: 1

name · string · required

Minimum string length: 1

category · enum<string> · required

Available options: payment, ecommerce, accounting, merchandising

enabled · boolean · required

config · object · required

Show child attributes