# Update client

Endpoint: PUT /clients/{id}
Version: v1
Security: http

## Path parameters:

  - `id` (string, required)

## Query parameters:

  - `findBy` (string)
    The field to search by
    Enum: "id", "external_id", "shortcode"

## Request fields (application/json):

  - `external_id` (string,null)

  - `name` (string)

  - `shortcode` (string,null)
    If not provided, the shortcode will be generated, Shortcode must be unique

  - `segment` (string)
    Enum: "A", "B", "C"

  - `primary_contact_id` (string,null)
    User ID of the account manager

## Response 200 fields (application/json):

  - `id` (string, required)

  - `external_id` (string,null, required)
    Can be used to add an identifier to the client from an external system, must be unique

  - `name` (string, required)

  - `shortcode` (string,null, required)

  - `segment` (string, required)
    Enum: "A", "B", "C"

  - `created_at` (string, required)

  - `primary_contact_id` (string,null, required)

  - `primaryContact` (object)

  - `primaryContact.first_name` (string, required)

  - `primaryContact.last_name` (string, required)

  - `primaryContact.title` (string,null, required)

  - `primaryContact.title_suffix` (string,null, required)

  - `primaryContact.email` (string, required)

  - `primaryContact.birthday` (string,null, required)

  - `primaryContact.gender` (string,null, required)

  - `primaryContact.position` (string,null, required)

  - `primaryContact.special_roles` (string,null, required)

  - `primaryContact.skills` (string,null, required)

  - `primaryContact.profile` (string,null, required)

  - `primaryContact.language` (string,null, required)
    UI language

  - `primaryContact.languages` (string,null, required)
    Spoken languages

  - `primaryContact.telephone_office` (string,null, required)
    Mobile phone (Office)

  - `primaryContact.phone_extension` (string,null, required)
    Landline phone (Office)

  - `primaryContact.telephone` (string,null, required)
    Mobile phone (Private)

  - `primaryContact.entry_date` (string,null, required)
    Date of joining the company

  - `primaryContact.leave_date` (string,null, required)
    Date of leaving the company - if set in the future, the employee will be archived on that date

  - `primaryContact.type` (string, required)
    Enum: "user", "guest", "tax_advisor"

  - `primaryContact.plan` (string, required)
    Enum: "basic", "standard", "external", "advanced", "expert", "guest", "tax_advisor", "not_assigned"

  - `primaryContact.is_owner` (boolean, required)
    Is Kanbert space owner

  - `primaryContact.avatar` (any, required)

  - `primaryContact.userGroups` (array)

  - `primaryContact.userGroups.is_team` (boolean, required)
    If true, this usergroup is shown as team

  - `primaryContact.userGroups.users` (array, required)

  - `primaryContact.userGroupsCount` (integer)

  - `primaryContact.userGroupsExists` (boolean)

  - `primaryContact.customFields` (object, required)
    The key is the field name for your custom field, value type depends on the field type

  - `primaryContact.deleted_at` (string,null, required)

  - `projects` (array)

  - `projects.external_id` (string,null, required)
    Can be used to add an identifier to the project from an external system, must be unique

  - `projects.po_number` (string,null, required)

  - `projects.projectType` (object, required)

  - `projects.projectType.color` (string, required)

  - `projects.projectType.order` (integer, required)

  - `projects.projectType.is_default` (boolean, required)

  - `projects.status` (string, required)

  - `projects.is_acquisition` (boolean, required)

  - `projects.is_private` (boolean, required)

  - `projects.client_id` (string, required)

  - `projects.project_type_id` (string,null, required)

  - `projects.start_date` (string,null, required)

  - `projects.end_date` (string,null, required)

  - `projects.client` (object)

  - `projects.tags` (array)

  - `projects.origin_space_id` (string,null, required)
    If set the client is shared from another Space

  - `projects.originSpace` (object)
    Shared space which the client is shared from

  - `projects.team` (array)
    Project team

  - `projects.team.added_at` (string, required)

  - `projects.team.space` (object, required)

  - `projects.guests` (array)
    Project guests

## Response 401 fields (application/json):

  - `message` (string, required)
    Error overview.

## Response 422 fields (application/json):

  - `message` (string, required)
    Errors overview.

  - `errors` (object, required)
    A detailed description of each field that failed validation.