PUT /clients/:id — propstack-api-v2-beta

latestSwagger 2.02026-08-2193114213.9 KB

ae1e0fe6da1a

clients

Update an existing client

put/clients/{id}

Path parameters

idinteger required

Request body

first_namestring

last_namestring

companystring

salutationstring

broker_idinteger

broker_idsinteger[]

department_idsinteger[]

team_idinteger

academic_titlestring

home_addressstring

office_addressstring

phonestring

home_phonestring

home_cellstring

office_phonestring

office_cellstring

dobstring date

birth_namestring

birth_placestring

birth_countrystring

identity_numberstring

issuing_authoritystring

nationalitystring

ratinginteger

scoreinteger

descriptionstring

preferred_contact_timestring

preferred_contact_channelstring

positionstring

emailsstring[]

home_streetstring

home_house_numberstring

home_zip_codestring

home_citystring

home_countrystring

office_streetstring

office_house_numberstring

office_zip_codestring

office_citystring

office_countrystring

tax_identification_numberstring

parent_idinteger

client_status_idinteger

client_source_idinteger

client_reason_idinteger

folder_idsinteger[]

group_idsinteger[]

project_idsinteger[]

mailchimp_interest_idsstring[]

locale'en' | 'de' | 'es' | 'fr' | 'id' | 'it' | 'ja' | 'nl' | 'pt-BR' | 'ru' | 'sv' | 'ar' | 'bg' | 'ca-CAT' | 'ca' | 'da-DK' | 'de-AT' | 'de-CH' | 'ee' | 'en-AU' | 'en-BORK' | 'en-CA' | 'en-GB' | 'en-IND' | 'en-MS' | 'en-NEP' | 'en-NG' | 'en-NZ' | 'en-PAK' | 'en-SG' | 'en-TH' | 'en-UG' | 'en-US' | 'en-ZA' | 'en-au-ocker' | 'es-AR' | 'es-MX' | 'fa' | 'fi-FI' | 'fr-CA' | 'fr-CH' | 'he' | 'hy' | 'ko' | 'lt' | 'lv' | 'mi-NZ' | 'nb-NO' | 'no-NO' | 'pl' | 'pt' | 'sk' | 'th' | 'tr' | 'uk' | 'vi' | 'zh-CN' | 'zh-TW' | 'hu' | 'cs' | 'da' | 'el' | 'et' | 'fi' | 'nb' | 'ro' | 'sl'

incomestring

handover_datestring date

rent_datestring date

followup_datestring date

mvsignedboolean

hvsignedboolean

newsletterboolean

newsletter_unsubscribedboolean

skip_newsletterboolean

property_mailing_wantedboolean

active_reservationsinteger[]

canceled_reservationsinteger[]

cancelation_reason_idsinteger[]

keep_data_tillstring date-time

contact_sync_broker_idsinteger[]

accept_contactboolean

lockedboolean

archivedboolean

message_salutationstring

warning_noticestring

pass_typestring

conspicuitystring

legal_formstring

register_numberstring

home_urlstring

office_urlstring

matrimonial_property_schemestring

bank_namestring

bank_account_ownerstring

bank_ibanstring

bank_bicstring

gdpr_statusinteger

commercialboolean

{"stackTrail":"components:schemas:putClientsId:properties:partial_custom_fields","oasType":"schema","type":"unknown","description":"An object containing custom fields and their values. Syntax: {\"my_custom_field\": \"my_custom_value\"}. If a value contains quotes, escape them, e.g. {\"my_custom_field\": \"example value \\\"key\\\": 0123\"}. Unknown custom field names return a validation_error."}

Response