Sale Co Agents

Update co agents

Replaces co-agent assignments for the specified sale. coAgentGuids must not be null; use an empty array to remove all co-agents. Returns 422 if any provided agent is not part of the subscriber, if more than 5 co-agents are supplied, or if the primary agent is included in coAgentGuids.

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.
  • CoAgentGuids cannot be null. Use an empty array to remove all co-agents.

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

Path parameters

saleGuidstring guid required

GUID of the sale whose co-agent assignments you want to update.

Request body

coAgentGuidsstring[] nullable

Response

valueUpdateSaleCoAgentsResponse
warningsstring[] nullable