Revise an open proposal and increment its version (scope proposals:write)

PATCH/api/v1/proposals/{id}

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

idstringrequired

min length 1

Request body

application/json

inputobject

rationalestring

max length 4000

evidencestring[]

max items 50

riskFlagsstring[]

max items 20

Responses

200

Revised proposal

proposalobjectrequired

Show properties

idstringrequired

capabilityIdstringrequired

statusstringrequired

Allowed:openacceptedcommittedcancelledexpired

versionintegerrequired

inputobjectrequired

rationalestring | nullrequired

evidenceany

metadataobjectrequired

Show properties

duplicateMatchesobject[]

Show properties

Array of object

idstringrequired

labelstring

reasonstringrequired

Allowed:kvkemailname_birthdaycompany_name

scorenumberrequired

confirmDuplicatesboolean

Allowed:true

riskFlagsstring[] | nullrequired

expiresAtstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

400

Invalid request

errorstringrequired

codestringrequired

rulestring

401

Unauthenticated

errorstringrequired

codestringrequired

rulestring

403

Forbidden (missing scope or permission)

errorstringrequired

codestringrequired

rulestring

404

Not found

errorstringrequired

codestringrequired

rulestring

409

Proposal cannot be revised

errorstringrequired

codestringrequired

rulestring

429

Rate limited

errorstringrequired

codestringrequired

rulestring

Request

curl -X PATCH '/api/v1/proposals/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "property1": null,
    "property2": null
  },
  "rationale": "string",
  "evidence": [
    "string"
  ],
  "riskFlags": [
    "string"
  ]
}'

const response = await fetch("/api/v1/proposals/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"input\": {\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"rationale\": \"string\",\n  \"evidence\": [\n    \"string\"\n  ],\n  \"riskFlags\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.patch(
    "/api/v1/proposals/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"input\": {\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"rationale\": \"string\",\n  \"evidence\": [\n    \"string\"\n  ],\n  \"riskFlags\": [\n    \"string\"\n  ]\n}",
)

Response

{
  "proposal": {
    "id": "string",
    "capabilityId": "string",
    "status": "open",
    "version": 1,
    "input": {
      "property1": null,
      "property2": null
    },
    "rationale": "string",
    "evidence": null,
    "metadata": {
      "duplicateMatches": [
        {
          "id": "string",
          "label": "string",
          "reason": "kvk",
          "score": 0
        }
      ],
      "confirmDuplicates": true
    },
    "riskFlags": [
      "string"
    ],
    "expiresAt": "string",
    "createdAt": "string",
    "updatedAt": "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"
}

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