Sales
Assign a document to a checklist item. The document must already exist on this sale (upl...
Assign a document to a checklist item. The document must already exist on this sale (upload via POST /api/files/sales/{saleGuid}/documents). The checklistItemId must be the ActivityId from the checklist array returned by GET /api/files/sales/{saleGuid}. Fetch the sale, identify the target checklist activityId, then call this endpoint with the document GUID.
Validation & Requirements
Required Parameters
- saleGuid (path, string, format=guid)
- checklistItemId (path, integer, format=int32)
- form (body, object)
Required JSON Body Fields
- documentGuid (format=guid, minLength=1)
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}
Request
- Base URLhttps://api.skyslope.com
- URLhttps://api.skyslope.com/api/files/sales/{saleGuid}/checklist-items/{checklistItemId}
- 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.