Commit an accepted, allowlisted proposal idempotently (scope proposals:write)

POST/api/v1/proposals/{id}/commit

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

idstringrequired

min length 1

Request body

application/json

idempotencyKeystringrequired

min length 1 · max length 200

Responses

200

Previously committed result replayed

One of:

object

outcomestringrequired

Allowed:already-committed

resultany

object

outcomestringrequired

Allowed:committed

resultany

object

outcomestringrequired

Allowed:duplicates

duplicatesobject[]required

Show properties

Array of object

idstringrequired

labelstring

reasonstringrequired

Allowed:kvkemailname_birthdaycompany_name

scorenumberrequired

object

outcomestringrequired

Allowed:failed

errorobjectrequired

Show properties

codestringrequired

Allowed:commit_failed

messagestringrequired

201

Proposal committed

One of:

object

outcomestringrequired

Allowed:already-committed

resultany

object

outcomestringrequired

Allowed:committed

resultany

object

outcomestringrequired

Allowed:duplicates

duplicatesobject[]required

Show properties

Array of object

idstringrequired

labelstring

reasonstringrequired

Allowed:kvkemailname_birthdaycompany_name

scorenumberrequired

object

outcomestringrequired

Allowed:failed

errorobjectrequired

Show properties

codestringrequired

Allowed:commit_failed

messagestringrequired

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

Acceptance conflict or duplicate relation matches

Any of:

object

errorstringrequired

codestringrequired

rulestring

object

outcomestringrequired

Allowed:already-committed

resultany

object

outcomestringrequired

Allowed:committed

resultany

object

outcomestringrequired

Allowed:duplicates

duplicatesobject[]required

Show properties

Array of object

idstringrequired

labelstring

reasonstringrequired

Allowed:kvkemailname_birthdaycompany_name

scorenumberrequired

object

outcomestringrequired

Allowed:failed

errorobjectrequired

Show properties

codestringrequired

Allowed:commit_failed

messagestringrequired

410

Proposal expired

errorstringrequired

codestringrequired

rulestring

429

Rate limited

errorstringrequired

codestringrequired

rulestring

502

Capability execution failed

One of:

object

outcomestringrequired

Allowed:already-committed

resultany

object

outcomestringrequired

Allowed:committed

resultany

object

outcomestringrequired

Allowed:duplicates

duplicatesobject[]required

Show properties

Array of object

idstringrequired

labelstring

reasonstringrequired

Allowed:kvkemailname_birthdaycompany_name

scorenumberrequired

object

outcomestringrequired

Allowed:failed

errorobjectrequired

Show properties

codestringrequired

Allowed:commit_failed

messagestringrequired

Request

curl -X POST '/api/v1/proposals/string/commit' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "idempotencyKey": "string"
}'

const response = await fetch("/api/v1/proposals/string/commit", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"idempotencyKey\": \"string\"\n}"
});

import requests

response = requests.post(
    "/api/v1/proposals/string/commit",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"idempotencyKey\": \"string\"\n}",
)

Response

{
  "outcome": "already-committed",
  "result": null
}

{
  "outcome": "already-committed",
  "result": null
}

{
  "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"
}

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

{
  "outcome": "already-committed",
  "result": null
}