Amendments

The conversation on a record — what the product calls an "update" posted underneath it.

GET/amendments/{recordId}

List amendments

Every amendment posted on a record, oldest first.

From an extension view: requires the amendments:read scope

Path parameters

recordId*

string

Record id.

bash

curl -X GET 'https://api.conexus-x.example/api/amendments/{recordId}' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json

{
  "amendments": [
    {
      "_id": "66f1a2b3c4d5e6f7a8b9c6f1",
      "record": "66f1a2b3c4d5e6f7a8b9c4d1",
      "module": "66f1a2b3c4d5e6f7a8b9c1a1",
      "workspace": "66f1a2b3c4d5e6f7a8b9c0d1",
      "user": {
        "_id": "66f1a2b3c4d5e6f7a8b9c0e1",
        "firstName": "Dana",
        "lastName": "Ortiz",
        "email": "dana@acme.example",
        "presence": "online"
      },
      "message": "Pushed the close date out two weeks — waiting on legal.",
      "parentComment": null,
      "edited": false,
      "isDeleted": false,
      "createdAt": "2026-08-01T11:20:00.000Z"
    }
  ]
}

POST/amendments/{recordId}

Post an amendment

Adds an amendment to a record, optionally as a reply to another one.

From an extension view: requires the amendments:write scope

Path parameters

recordId*

string

Record id.

Body

message*	string	The note text.
parentComment	string	Set to reply to an existing amendment.
mentions	string[]	User ids picked via @-autocomplete.

bash

curl -X POST 'https://api.conexus-x.example/api/amendments/{recordId}' \
  -H 'x-api-key: YOUR_PIT_KEY'
  -H 'Content-Type: application/json' \
  -d '{"message":"Pushed the close date out two weeks — waiting on legal."}'

Example response

json

{
  "amendment": {
    "_id": "66f1a2b3c4d5e6f7a8b9c6f1",
    "record": "66f1a2b3c4d5e6f7a8b9c4d1",
    "module": "66f1a2b3c4d5e6f7a8b9c1a1",
    "workspace": "66f1a2b3c4d5e6f7a8b9c0d1",
    "user": {
      "_id": "66f1a2b3c4d5e6f7a8b9c0e1",
      "firstName": "Dana",
      "lastName": "Ortiz",
      "email": "dana@acme.example",
      "presence": "online"
    },
    "message": "Pushed the close date out two weeks — waiting on legal.",
    "parentComment": null,
    "edited": false,
    "isDeleted": false,
    "createdAt": "2026-08-01T11:20:00.000Z"
  }
}

PUT/amendments/{amendmentId}

Edit an amendment

Edits an amendment the caller wrote.

From an extension view: requires the amendments:write scope

Path parameters

amendmentId*

string

Amendment id.

Body

message*

string

New text.

bash

curl -X PUT 'https://api.conexus-x.example/api/amendments/{amendmentId}' \
  -H 'x-api-key: YOUR_PIT_KEY'
  -H 'Content-Type: application/json' \
  -d '{"message":"Pushed the close date out three weeks now."}'

Example response

json

{
  "amendment": {
    "_id": "66f1a2b3c4d5e6f7a8b9c6f1",
    "record": "66f1a2b3c4d5e6f7a8b9c4d1",
    "module": "66f1a2b3c4d5e6f7a8b9c1a1",
    "workspace": "66f1a2b3c4d5e6f7a8b9c0d1",
    "user": {
      "_id": "66f1a2b3c4d5e6f7a8b9c0e1",
      "firstName": "Dana",
      "lastName": "Ortiz",
      "email": "dana@acme.example",
      "presence": "online"
    },
    "message": "Pushed the close date out two weeks — waiting on legal.",
    "parentComment": null,
    "edited": true,
    "isDeleted": false,
    "createdAt": "2026-08-01T11:20:00.000Z"
  }
}

DELETE/amendments/{amendmentId}

Delete an amendment

Deletes an amendment. A deleted parent with live replies is kept as a tombstone.

From an extension view: requires the amendments:write scope

Path parameters

amendmentId*

string

Amendment id.

bash

curl -X DELETE 'https://api.conexus-x.example/api/amendments/{amendmentId}' \
  -H 'x-api-key: YOUR_PIT_KEY'

Example response

json

{
  "message": "Amendment deleted."
}