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 | ||
| partnerCode | string | Partner to assign. Null = no change, empty string = unassign, user code = assign. |
Partner to assign. Null = no change, empty string = unassign, user code = assign. | ||
| managerCode | string | Manager to assign. Null = no change, empty string = unassign, user code = assign. |
Manager to assign. Null = no change, empty string = unassign, user code = assign. | ||
| associateCode | string | Associate to assign. Null = no change, empty string = unassign, user code = assign. |
Associate to assign. Null = no change, empty string = unassign, user code = assign. | ||
| pclSent | boolean | PCL sent status. Null = no change. |
PCL sent status. Null = no change. | ||
| status | enum | Active Inactive Prospect LostProspect |
Active Inactive Prospect LostProspect | ||
| teamCodes | array of string | Teams to assign. Null = no change, empty array = clear all, team codes = replace. |
Teams to assign. Null = no change, empty array = clear all, team codes = replace. | ||
| contactByPost | boolean | Whether the clients can be contacted by post. Null = no change. |
Whether the clients can be contacted by post. Null = no change. | ||
| contactByTelephone | boolean | Whether the clients can be contacted by telephone. Null = no change. |
Whether the clients can be contacted by telephone. Null = no change. | ||
| contactByEmail | boolean | Whether the clients can be contacted by email. Null = no change. |
Whether the clients can be contacted by email. Null = no change. | ||
| contactBySms | boolean | Whether the clients can be contacted by SMS. Null = no change. |
Whether the clients can be contacted by SMS. Null = no change. | ||
JSON Example
{
"codes": [
"string"
],
"partnerCode": "string",
"managerCode": "string",
"associateCode": "string",
"pclSent": false
}