API Docs / Schemas / BulkUpdateClientsRequest

BulkUpdateClientsRequest

Request to bulk update multiple clients. At least one update field must be provided.
For PartnerCode, ManagerCode, and AssociateCode: null means "don't change", a user code means "assign", and an empty string means "unassign".

Properties

Name Type Description
codes*array of string

List of client codes to update

List of client codes to update

partnerCodestring

Partner to assign. Null = no change, empty string = unassign, user code = assign.

Partner to assign. Null = no change, empty string = unassign, user code = assign.

managerCodestring

Manager to assign. Null = no change, empty string = unassign, user code = assign.

Manager to assign. Null = no change, empty string = unassign, user code = assign.

associateCodestring

Associate to assign. Null = no change, empty string = unassign, user code = assign.

Associate to assign. Null = no change, empty string = unassign, user code = assign.

pclSentboolean

PCL sent status. Null = no change.

PCL sent status. Null = no change.

statusenum

Active Inactive Prospect LostProspect

Active Inactive Prospect LostProspect

teamCodestring

Team to assign. Null = no change, empty string = unassign, team code = assign.

Team to assign. Null = no change, empty string = unassign, team code = assign.

JSON Example

{
  "codes": [
    "string"
  ],
  "partnerCode": "string",
  "managerCode": "string",
  "associateCode": "string",
  "pclSent": false
}

Used By Operations