latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Listings

Add a note to a checklist item

Notes are visible to all users with access to the listing. Adding a note updates the listing's modifiedOn and checklistModifiedOn timestamps. Notes cannot be edited or deleted after creation. Note text is required and must be 1000 characters or fewer.

Validation & Requirements

Required Parameters

  • listingGuid (path, string, format=guid)
  • checklistItemId (path, integer, format=int32)
  • form (body, object)

Required JSON Body Fields

  • None

Validations

  • Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
  • Invalid date values in *date* fields return 422 Unprocessable Entity.
  • Missing required request body returns 422 Unprocessable Entity with Missing request body..
  • Additional business-rule validation may return 422 with details in the errors array.

Integration Requirement

  • Retrieve the corresponding ...Form endpoint immediately before write operations to get current dynamic required fields and allowed values.
post/api/files/listings/{listingGuid}/checklist-items/{checklistItemId}/notes

Path parameters

listingGuidstring guid required

The listing GUID.

checklistItemIdinteger required

The ActivityId of the checklist item (from the listing's checklist array).

Request body

notestring nullable

Response

valueAddNoteToListingChecklistItemResponse
warningsstring[] nullable