Sales

Unassign a document from a checklist item. The document remains on the sale but is no longer linked to the checklist item; the checklist item returns to an unfulfilled state.

To completely remove the document, use DELETE /api/files/sales/{saleGuid}/documents/{documentGuid}.

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}/unassign

Request

  • Base URL
    https://api.skyslope.com
  • URL
    https://api.skyslope.com/api/files/sales/{saleGuid}/checklist-items/{checklistItemId}/unassign
  • Auth
    OpenID 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

documentGuidstring guid required

Existing document guid.

Response

warningsstring[] nullable

Changes

No recorded changes to this operation across all 6 revisions of this API.