Sign in
latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Checklists

Copy checklists

Copies selected checklists from a source office to one or more target offices. checklistNames and targetOfficeGuids are required and must be non-empty. transactionType must be Listing or Sale. User must have office access and be Broker/Auditor. Returns 422 if source checklists or target/source offices are invalid/inactive.

Validation & Requirements

Required Parameters

  • sourceOfficeGuid (path, string, format=guid)
  • 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.
post/api/offices/{sourceOfficeGuid}/checklists/copy

Path parameters

sourceOfficeGuidstring guid required

GUID of the source office to copy checklists from.

Request body

checklistNamesstring[] nullable

Array of checklist names to copy from the source office

targetOfficeGuidsstring[] nullable

Array of target office GUIDs where checklists will be copied

transactionType'Listing' | 'Sale'
overrideboolean

When true, deletes existing checklist activities in target offices before copying. Default: false

Response

warningsstring[] nullable