BIbigchange
Notes

Update a note's progress

Changed on

Updates the percentage completion of a note (required scope notes:write)

put/v1/notes/{noteId}/progress

Request

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

Path parameters

noteIdinteger required

The unique identifier of the note

Headers

Customer-Idinteger required

The customer identifier

Request body

progressedAtstring date-time nullable

The UTC timestamp of when this note was progressed. Must be unique to the second. Defaults to UTC now if no value specified. If a note progress more recent than this value already exists, the note fields will not be updated

percentageinteger required

The percentage to progress the note to. Must be between 0 - 100 inclusive. Setting to 100 will not complete the note, this must be done manually via the patch endpoint

commentstring nullable

Free text description about progress made by this update

Example request

{
  "progressedAt": "2023-09-12T11:24:23.0000000+00:00",
  "percentage": 50,
  "comment": "Sent out the new part"
}

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