Update a client

POSThttp://localhost:4000/api/clients/update

Changes the details of a client. Send only the fields you want to change.

Your API key needs the clients.MANAGE permission.

Body Params

idintegerrequired

ID of the client to update.

firstNamestring

First name.

lastNamestring

Last name.

emailstring

Email address. Masked or left out when the API key lacks email visibility.

phoneCountryCodestring

Two-letter country code of the phone number, for example CY.

phoneDialCodeinteger

International dial code without the plus sign, for example 357.

phoneinteger

National phone number, digits only. Masked or left out when the API key lacks phone visibility.

genderenum

Gender.

languagestring

Preferred language code, for example en.

countrystring

Country name.

citystring

City.

addressstring

Street address.

stageIdinteger

ID of the pipeline stage.

doNotContactboolean

True when the client must not be contacted.

labelIdsarray of integer

IDs of the labels on this client.

interestTypesarray of string

What the client wants to do: BUY or RENT.

preferredPropertyTypesarray of string

Property types the client is interested in.

preferredCountrystring

Country the client wants to buy or rent in.

preferredCitystring

City the client wants to buy or rent in.

preferredAreastring

Area the client wants to buy or rent in.

preferredBedroomsinteger

Number of bedrooms wanted.

preferredBathroomsinteger

Number of bathrooms wanted.

purchasePurposeenum

Why the client is buying.

propertyStageInterestsarray of string

Construction stages the client is interested in.

preferredFeaturesarray of string

Property features the client wants.

deliveryDeadlinestring

Latest delivery date that suits the client.

interestNotesstring

Free text notes about what the client wants.

minBudgetnumber

Lowest budget.

maxBudgetnumber

Highest budget.

Responses

200Successful response.
400The request is not valid.
401The API key is missing, invalid, expired or disabled.
403The API key does not have the permission this endpoint needs.