Sale Referring Agents
Add referring agent
Adds a referring agent to the sale. A sale has one referring agent. firstName and lastName are required. When provided, email must be valid and phone/fax/alternatePhone must be 10 numerical digits. Invalid payloads return 422.
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.
post/api/files/sales/{saleGuid}/referringagent
Path parameters
saleGuidstring guid required
GUID of the sale you want to add a referring agent to.