latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Sale Referring Agents

Update referring agent

Updates the sale's referring agent details. firstName and lastName are required. email is required on update and must be valid. Phone, fax, and alternatePhone must be 10 numerical digits when provided.

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.
  • If provided, email must be valid.
  • Phone, fax, and alternate phone must be exactly 10 numeric digits.

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

Path parameters

saleGuidstring guid required

GUID of the sale whose referring agent you want to update.

Request body

firstNamestring nullable
lastNamestring nullable
phoneNumberstring nullable
emailstring nullable
alternatePhonestring nullable
faxstring nullable
companystring nullable
streetNumberstring nullable
streetAddressstring nullable
citystring nullable
statestring nullable
zipstring nullable
publicIDstring nullable

Response

warningsstring[] nullable