Upload bytes for a new document or document version

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

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

idstringrequired

Query parameters

relativePathstringrequired

documentIdstring

Request body

application/octet-stream

string<binary>

Responses

200

Updated existing document

contractVersionstringrequired

Allowed:v1

documentIdstringrequired

checksumstringrequired

201

Created new document

contractVersionstringrequired

Allowed:v1

documentIdstringrequired

checksumstringrequired

400

Invalid request

errorstringrequired

codestringrequired

rulestring

401

Unauthenticated

errorstringrequired

codestringrequired

rulestring

403

Forbidden (missing scope or permission)

errorstringrequired

codestringrequired

rulestring

413

File too large

errorstringrequired

codestringrequired

rulestring

429

Rate limited

errorstringrequired

codestringrequired

rulestring

Request

curl -X POST '/api/v1/sync/matters/string/documents?relativePath=string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/octet-stream' \
  -d 'string'

const response = await fetch("/api/v1/sync/matters/string/documents?relativePath=string", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/octet-stream"
  },
  body: "string"
});

import requests

response = requests.post(
    "/api/v1/sync/matters/string/documents?relativePath=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/octet-stream"
    },
    data="string",
)

Response

{
  "contractVersion": "v1",
  "documentId": "string",
  "checksum": "string"
}

{
  "contractVersion": "v1",
  "documentId": "string",
  "checksum": "string"
}

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

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

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

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

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