Enable or disable a matter subscription for the authenticated device

POST/api/v1/sync/subscriptions

Authorization

AuthorizationBearer token · headerrequired

Scoped API token (bnx_…). Required scopes are noted per operation.

Request body

application/json

matterIdstringrequired

min length 1

enabledbooleanrequired

Responses

200

Subscription state and selected contract version

contractVersionstringrequired

Allowed:v1

matterIdstringrequired

enabledbooleanrequired

400

Invalid request

errorstringrequired

codestringrequired

rulestring

401

Unauthenticated

errorstringrequired

codestringrequired

rulestring

403

Forbidden (missing scope or permission)

errorstringrequired

codestringrequired

rulestring

429

Rate limited

errorstringrequired

codestringrequired

rulestring

Request

curl -X POST '/api/v1/sync/subscriptions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "matterId": "string",
  "enabled": true
}'

const response = await fetch("/api/v1/sync/subscriptions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"matterId\": \"string\",\n  \"enabled\": true\n}"
});

import requests

response = requests.post(
    "/api/v1/sync/subscriptions",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"matterId\": \"string\",\n  \"enabled\": true\n}",
)

Response

{
  "contractVersion": "v1",
  "matterId": "string",
  "enabled": true
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}