Sales
Add a note to a checklist item. Notes are visible to all users with access to the sale.
Adding a note updates the sale's modifiedOn and checklistModifiedOn timestamps. Notes cannot be edited or deleted after creation.
Validation & Requirements
Required Parameters
- saleGuid (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/sales/{saleGuid}/checklist-items/{checklistItemId}/notes
Request
- Base URLhttps://api.skyslope.com
- URLhttps://api.skyslope.com/api/files/sales/{saleGuid}/checklist-items/{checklistItemId}/notes
- AuthOpenID Connect (https://example.com/.well-known/openid-configuration)
Path parameters
saleGuidstring guid required
The sale GUID.
checklistItemIdinteger required
The ActivityId of the checklist item (from the sale's checklist array).
Request body
Response
Changes
No recorded changes to this operation across all 6 revisions of this API.