Clients

Replaces every updatable field of a client (BF-7501).

Full replace of businessName, clientCode, phone, fax and isActive. businessName and isActive are required; clientCode, phone and fax are cleared when absent or null - use PATCH to change only some. Field names are those of GET /v1/Clients/{clientId}, so its data can be sent back; other keys are ignored. A clientId in the body must equal the route. businessName must not be used by another client of the company. Phone and fax format rules apply only to values that change. Deactivating a client does not change its jobs, contacts or addresses. When every value equals the stored one nothing is written.

put/v{version}/Clients/{clientId}

Path parameters

clientIdinteger required
versionstring required

Headers

company-idstring required

Request body

clientIdinteger
businessNamestring nullable
clientCodestring nullable
phonestring nullable
faxstring nullable
isActiveboolean nullable

Response

Success

isValidboolean
errorsstring[] nullable
warningsstring[] nullable
infostring[] nullable
messagestring nullable

Changes

Changed in 1 of the 8 revisions of this API.1