Sign in
Clients

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

Fields: companyName, departmentName, contactName, address, suite, city, state, zipCode, addressCode, isDefault (required). Every other field that is absent or null is cleared, addressCode included - use PATCH to change only some. Names are those of GET /v1/Clients/addresses/{clientId}; isActive and other keys are ignored. state is a two-letter US state code. isDefault true makes this the client's only default address. companyName and address cannot be cleared. Format rules apply only to values that change. clientId and addressId in the body must equal the route.

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

Path parameters

clientIdinteger required
addressIdinteger required
versionstring required

Headers

company-idstring required

Request body

clientIdinteger
addressIdinteger
companyNamestring nullable
departmentNamestring nullable
contactNamestring nullable
addressstring nullable
suitestring nullable
citystring nullable
statestring nullable
zipCodestring nullable
addressCodestring nullable
isDefaultboolean nullable

Response

Success

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

Changes

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