--- title: "PUT /clients/{id}" method: PUT path: "/clients/{id}" tags: ["clients"] --- # PUT /clients/{id} `PUT /clients/{id}` Update an existing client ## Path parameters - `id` integer, required ## Request body - PutClientsId — Update an existing client - `first_name` string - `last_name` string - `company` string - `salutation` string - `broker_id` integer - `broker_ids` integer[] - `department_ids` integer[] - `team_id` integer - `academic_title` string - `home_address` string - `office_address` string - `phone` string - `home_phone` string - `home_cell` string - `office_phone` string - `office_cell` string - `dob` string, date - `birth_name` string - `birth_place` string - `birth_country` string - `identity_number` string - `issuing_authority` string - `nationality` string - `rating` integer - `score` integer - `description` string - `preferred_contact_time` string - `preferred_contact_channel` string - `position` string - `emails` string[] - `home_street` string - `home_house_number` string - `home_zip_code` string - `home_city` string - `home_country` string - `office_street` string - `office_house_number` string - `office_zip_code` string - `office_city` string - `office_country` string - `tax_identification_number` string - `parent_id` integer - `client_status_id` integer - `client_source_id` integer - `client_reason_id` integer - `folder_ids` integer[] - `group_ids` integer[] - `project_ids` integer[] - `mailchimp_interest_ids` string[] - `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' - `income` string - `handover_date` string, date - `rent_date` string, date - `followup_date` string, date - `mvsigned` boolean - `hvsigned` boolean - `newsletter` boolean - `newsletter_unsubscribed` boolean - `skip_newsletter` boolean - `property_mailing_wanted` boolean - `active_reservations` integer[] - `canceled_reservations` integer[] - `cancelation_reason_ids` integer[] - `keep_data_till` string, date-time - `contact_sync_broker_ids` integer[] - `accept_contact` boolean - `locked` boolean - `archived` boolean - `message_salutation` string - `warning_notice` string - `pass_type` string - `conspicuity` string - `legal_form` string - `register_number` string - `home_url` string - `office_url` string - `matrimonial_property_scheme` string - `bank_name` string - `bank_account_owner` string - `bank_iban` string - `bank_bic` string - `gdpr_status` integer - `commercial` boolean - `partial_custom_fields` unknown - `client_addresses_attributes` object[] - `id` integer, required — Existing client address id. Required when _destroy is true. - `_destroy` boolean — Set true together with id to delete an existing client address. - `label` string, required — Address label. Required when creating/updating (_destroy is false or omitted). - `value` string, required — Address value (email/phone). Required when creating/updating (_destroy is false or omitted). ## Response `200` Update an existing client - ClientEntity — ClientEntity model - `id` integer - `old_crm_id` integer - `broker_id` integer - `broker_ids` integer[] - `second_broker_id` integer - `item_id` integer - `salutation` string - `academic_title` string - `first_name` string - `last_name` string - `name` string - `home_address` string - `office_address` string - `phone` string - `home_phone` string - `home_cell` string - `office_phone` string - `office_cell` string - `email` string - `dob` string - `birth_name` string - `birth_place` string - `birth_country` string - `identity_number` string - `issuing_authority` string - `nationality` string - `rating` integer - `description` string - `company` string - `position` string - `full_salutation` string - `emails` string[] - `photo` ClientPhotoEntity - `urls` object — Photo URLs by size: original keeps the uploaded dimensions, small is 100x100, medium is 512x512, large is 1024x1024 - `home_street` string - `home_house_number` string - `home_zip_code` string - `home_city` string - `home_country` string - `office_street` string - `office_house_number` string - `office_zip_code` string - `office_city` string - `office_country` string - `tax_identification_number` string - `token` string - `parent_id` integer - `client_status_id` integer - `client_source_id` integer - `folder_ids` integer[] - `group_ids` integer[] - `child_ids` integer[] - `mailchimp_interest_ids` string[] - `delete_with_activities` boolean - `client_addresses` ClientAddressEntity - `id` integer - `value` string - `label` string - `language` string - `custom_fields` object - `income` string - `handover_date` string - `rent_date` string - `mvsigned` boolean - `hvsigned` boolean - `followup_date` string - `newsletter` boolean - `newsletter_unsubscribed` boolean - `property_mailing_wanted` boolean - `accept_contact` boolean - `locked` boolean - `archived` boolean - `message_salutation` string - `warning_notice` string - `pass_type` string - `conspicuity` string - `legal_form` string - `register_number` string - `creator_id` integer - `updater_id` integer - `home_url` string - `office_url` string - `matrimonial_property_scheme` string - `bank_name` string - `bank_account_owner` string - `bank_iban` string - `bank_bic` string - `gdpr_status` integer - `client_reason_id` integer - `project_ids` integer[] - `commercial` boolean - `has_tipster` boolean - `cp_delete_request_date` string - `keep_data_till` string - `created_at` string - `updated_at` string - `last_contact_at` string - `last_interaction_at` string - `last_response_at` string ## Other responses - `400` — validation_error - `401` — authentication_error - `403` — authorization_error - `404` — not_found_error - `422` — validation_error - `500` — internal_server_error --- [API](https://skmtc.net/propstack/apis/propstack-api-v2-beta.md) · [All operations](https://skmtc.net/propstack/apis/propstack-api-v2-beta/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/propstack/propstack-api-v2-beta/revisions/ae1e0fe6da1a/schema)