latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Sale custom fields

Update custom fields

Updates sale custom fields for the specified sale. Returns 422 if subscriber custom fields are not enabled, if isConcierge is not Yes/No, or if serviceType is not one of the allowed values.

Validation & Requirements

Required Parameters

  • saleGuid (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.

Integration Requirement

  • Retrieve the corresponding ...Form endpoint immediately before write operations to get current dynamic required fields and allowed values.
put/api/files/sales/{saleGuid}/customFields

Path parameters

saleGuidstring guid required

GUID of the sale whose custom fields you want to update.

Request body

isConciergestring nullable
conciergeProjectNumberstring nullable
serviceTypestring nullable

Response

warningsstring[] nullable