Commit the post-transfer baseline for a matter

POST/api/v1/sync/matters/{id}/commit

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

idstringrequired

Request body

application/json

supportedContractVersionsstring[]

min items 1 · default: ["v1"]

itemsobject[]required

max items 50000

Show properties

Array of object

relativePathstringrequired

min length 1

documentIdstring | nullrequired

dmsChecksumstring | nullrequired

deviceChecksumstring | nullrequired

syncStatestringrequired

Allowed:syncedconflictdms_deleteddevice_deletedpending

removePathsstring[]

max items 50000

Responses

200

Committed baseline count and selected contract version

contractVersionstringrequired

Allowed:v1

matterIdstringrequired

committedintegerrequired

min 0

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/matters/string/commit' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "supportedContractVersions": [
    "v1"
  ],
  "items": [
    {
      "relativePath": "string",
      "documentId": "string",
      "dmsChecksum": "string",
      "deviceChecksum": "string",
      "syncState": "synced"
    }
  ],
  "removePaths": [
    "string"
  ]
}'

const response = await fetch("/api/v1/sync/matters/string/commit", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"supportedContractVersions\": [\n    \"v1\"\n  ],\n  \"items\": [\n    {\n      \"relativePath\": \"string\",\n      \"documentId\": \"string\",\n      \"dmsChecksum\": \"string\",\n      \"deviceChecksum\": \"string\",\n      \"syncState\": \"synced\"\n    }\n  ],\n  \"removePaths\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.post(
    "/api/v1/sync/matters/string/commit",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"supportedContractVersions\": [\n    \"v1\"\n  ],\n  \"items\": [\n    {\n      \"relativePath\": \"string\",\n      \"documentId\": \"string\",\n      \"dmsChecksum\": \"string\",\n      \"deviceChecksum\": \"string\",\n      \"syncState\": \"synced\"\n    }\n  ],\n  \"removePaths\": [\n    \"string\"\n  ]\n}",
)

Response

{
  "contractVersion": "v1",
  "matterId": "string",
  "committed": 0
}

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

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

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

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