BIbigchange
Notes

Update a note

Changed on

Updates the details of a single note (required scope notes:write)

patch/v1/notes/{noteId}

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/notes/{noteId}
  • Auth
    HTTP bearer

Path parameters

noteIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

typeIdinteger

The unique identifier of the note type definition associated to this note<br/><br/>Optional: Omit to retain current value

subjectstring

The subject of the note<br/><br/>Optional: Omit to retain current value

ownedByUserIdinteger

The unique id of the user who owns the note. Must have an active licence<br/><br/>Optional: Omit to retain current value

dueAtstring date-time nullable

The UTC timestamp of when this note is due for completion<br/><br/>Optional: Omit to retain current value or provide null to unset

parentIdinteger nullable

The unique identifier of the parent note of this note<br/><br/>Optional: Omit to retain current value or provide null to unset

referencestring

The internal reference of the note - should usually be unique<br/><br/>Optional: Omit to retain current value

status'open' | 'completed' | 'cancelled'

The status of the note<p>Possible values:</p><ul><li><b>open</b>: Open</li><li><b>completed</b>: Completed</li><li><b>cancelled</b>: Cancelled</li></ul>

completionTextstring nullable

The completion text for the note<br/><br/>Optional: Omit to retain current value or provide null to unset

descriptionstring

The detailed textual content about the note<br/><br/>Optional: Omit to retain current value

Example request

{
  "typeId": 5514123,
  "subject": "Call Mr Brown",
  "ownedByUserId": 67246,
  "dueAt": "2022-11-29T16:50:16.0000000+00:00",
  "parentId": 5514123,
  "reference": "REF420",
  "status": "open",
  "completionText": "Completed",
  "description": "Message left by Mr Brown regarding the recent installation of his CCTC cameras. He can't get one of them working and needs some technical support.",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

No Content

Changes

  • 5306509f5616Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body oneOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status