---
title: "Update Client"
method: PUT
path: "/clients/{client_id}"
tags: ["Client"]
---

# Update Client

`PUT /clients/{client_id}`

Update a Client record given the Client identifier and Client data. Any fields not provided in the request will be ignored.

## Path parameters

- `client_id` integer, required

## Headers

- `x-api-key` string, required

## Request body

- RequestPutClient — Data to Update a Client
  - `first_name` string — Client's First Name
  - `last_name` string — Client's Last Name
  - `email` string — Clien'ts Email Address
  - `phone_number` string — Client's Phone Number
  - `billing_cc_email` string — Client's Billing CC Email
  - `client_status_id` integer — Client's Status Id
  - `location_id` integer — Client's Location Id
  - `default_program_id` integer — Client's Default Program Id
  - `date_of_birth` string, date — Client's Date of Birth
  - `gender_id` integer — Client's Gender Id
  - `street_address_1` string — Client's Street Address 1
  - `street_address_2` string — Client's Street Address 2
  - `city` string — Client's City
  - `state_id` integer — Client's State Id
  - `province` string — Client's Province
  - `zipcode` string — Client's Zipcode
  - `country_id` integer — Client's Country Id
  - `timezone_id` integer — Client's TimeZone Id
  - `height_measurement_1` integer — The 1st component of the user's height measurement. (Feet or meters depending on the UOM chosen).
  - `height_measurement_2` integer — The 2nd component of the user's height measurement. (Inches or centimeters depending on the UOM chosen).
  - `weight` number — Client's Weight
  - `is_email_subscribed` string — Determines if the Client is subscribed to receive emails
  - `notes` string — Client's Notes
  - `is_overwrite_notes` boolean — If true, any existing notes will be overwritten with the notes value provided. If true and no notes are provided, notes will get cleared out. If faults, any notes provided will be appeneded to the existing notes. Default value is False.
  - `emergency_contact_name` string — Client's Emergency Contact
  - `emergency_contact_phone` string — Client's Emergency Contact Phone Number
  - `lead_source_id` integer — The Id of the Lead Source if the Client was converted from a Lead
  - `referring_user_id` integer — The Id of the User that referred the Lead, if the Client was converted from a Lead
  - `is_sms_subscribed` string
  - `client_owner_id` integer — user id of client owner
  - `coach_title` string — coach title
  - `coach_bio` string — coach biography html
  - `coach_link_1_icon` string — coach link 1 icon
  - `coach_link_1_url` string — coach link 1 url
  - `coach_link_2_icon` string — coach link 2 icon
  - `coach_link_2_url` string — coach link 2 url
  - `coach_link_3_icon` string — coach link 3 icon
  - `coach_link_3_url` string — coach link 3 url
  - `coach_link_4_icon` string — coach link 4 icon
  - `coach_link_4_url` string — coach link 4 url
  - `coach_link_5_icon` string — coach link 5 icon
  - `coach_link_5_url` string — coach link 5 url

## Response `200`

Returned Data for a Client

- ClientResponse — Client Data
  - `id` integer — ClientId
  - `first_name` string — Client's First Name
  - `last_name` string — Client's Last Name
  - `email` string — Clien'ts Email Address
  - `phone_number` string — Client's Phone Number
  - `billing_cc_email` string — Client's Billing CC Email
  - `client_status_id` integer — Client's Status Id
  - `client_status` string — Client's Status
  - `location_id` integer — Client's Location Id
  - `location` string — Client's Location
  - `default_program_id` integer — Client's Default Gym Program Id
  - `default_program` string — Client's Default Gym Program
  - `date_of_birth` string, date — Client's Date of Birth
  - `gender_id` integer — Client's Gender Id
  - `gender` string — Client's Gender
  - `street_address_1` string — Client's Street Address 1
  - `street_address_2` string — Client's Street Address 2
  - `city` string — Client's City
  - `state_id` integer — Client's State Id
  - `state` string — Client's State
  - `province` string — Client's Province
  - `zipcode` string — Client's Zipcode
  - `country_id` integer — Client's Country Id
  - `country` string — Client's Country
  - `timezone_id` integer — Client's TimeZone Id
  - `timezone` string — Client's TimeZone
  - `height_measurement_1` integer — The 1st component of the user's height measurement. (Feet or meters depending on the UOM chosen).
  - `height1_system_of_measure` string — System of Measure for Height 1
  - `height_measurement_2` integer — The 2nd component of the user's height measurement. (Inches or centimeters depending on the UOM chosen).
  - `height2_system_of_measure` string — System of Measure for Height 2
  - `weight` number — Client's Weight
  - `weight_system_of_measure` string — Customer's system of measurement for weight and height.
  - `is_email_subscribed` boolean — Determines if the Client is subscribed to receive emails
  - `is_sms_subscribed` boolean — Determines if the Client is subscribed to receive SMS
  - `tags` string[] — Client's Tags
  - `notes` string — Client's Notes
  - `group` ClientGroup — Data for the client's group
    - `group_id` integer — Client's GroupId
    - `group_role_id` integer — The Clients role in the group (Id)
    - `group_role` string — The Clients role in the group
    - `other_group_participants` GroupParticipants[] — List of Members in the Clients Group
      - `group_participant_client_id` integer — The Client Id of the Group Participant
      - `group_participant_name` string — Name of the Client in the Group
      - `group_role_id` integer — Participant Type of the Client in the Group (Id)
      - `group_role` string — Participant Type of the Client in the Group
  - `created` Created — Record creation data.
    - `created_by_id` integer — Unique ID of the user that created the record.
    - `created_by` string — Name of the user that created the record.
    - `created_on_datetime` string, date-time — Datetime on which the record was created.
  - `updated` Updated — Update info
    - `updated_by_id` integer — Unique ID of the user that last updated the record.
    - `updated_by` string — Name of the user that most recently updated the record.
    - `updated_on_datetime` string, date-time — Datetime on which the record was last updated.
  - `status_history` ClientStatusHistory[] — History of the Client's status changes
    - `from_status_id` integer — From Status (Identifier)
    - `from_status` string — From Status
    - `to_status_id` integer — To Status (Identifier)
    - `to_status` string — To Status
    - `status_change_datetime` string, date-time — Datetime that the Lead's status change occurred
  - `emergency_contact_name` string — Client's Emergency Contact
  - `emergency_contact_phone` string — Client's Emergency Contact Phonne Number
  - `has_overdue_invoices` boolean — Indicates if the Client has unpaid invoices
  - `has_membership` boolean — Indicates if the Client has any active Memberships
  - `has_payment_method` boolean — Indicates if a Client has a Payment Method on file
  - `has_store_credit` boolean — Determines if the Client has store credit
  - `last_attendance` string, date-time — Datetime that the Clien't last attended a class/session/appointment.
  - `days_since_last_attended` integer — Number of days since the Client last attended
  - `member_since` string, date — The Date the Client has been a member since
  - `last_contacted` string, date — Date the Client was last contacted
  - `is_at_risk` boolean
  - `retain_snooze_until_date` string, date — Retain Snooze Until Date
  - `is_initial_email_sent` boolean — Indicates if the Initial Welcome Email has been sent to the Client
  - `lead_id` integer — Id of the Lead that Client was converted from
  - `lead_source_id` integer — The Id of the Lead Source if the Client was converted from a Lead
  - `lead_source` string — The Lead Source if the Client was converted from a Lead
  - `referring_user_id` integer — The Id of the User that referred the Lead, if the Client was converted from a Lead
  - `referring_user` string — The Name of the User that referred the Lead, if the Client was converted from a Lead
  - `is_converted_from_lead` boolean — Indicates if the Client was converted from a Lead
  - `member_deactivation_reason` string — The reason why the Client was deactivated
  - `roles` ClientRole[] — List of the roles that the Client has
    - `id` integer — Role Id
    - `role` string — Name of the role
  - `available_programs` ProgramAPI[]
    - `program_id` integer — Program Id
    - `program` string — Program name
  - `client_owner_id` integer — user id of client owner
  - `client_owner` string — name of client owner
  - `total_class_sign_ins` integer — Total number of Classes the Client has signed into.
  - `total_booking_sign_ins` integer — Total number of Appointment Bookings the Client has signed into.
  - `last_class_sign_in` string, date-time — Date and time of the last Class the Client has signed into.
  - `last_booking_sign_in` string, date-time — Date and time of the last Appointment Booking the Client has signed into.
  - `current_weekstreak` integer — Clients Current weekstreak
  - `highest_weekstreak` integer — Clients Highest weekstreak
  - `current_weekstreak_updatedon` string, date-time — The last time the user had their weekstreak updated on.
  - `coach_title` string — coach title
  - `coach_bio` string — coach biography html
  - `is_display_coach_on_mobile_app` boolean — Is Display On Mobile App
  - `coach_link_1_icon` string — coach link 1 icon
  - `coach_link_1_url` string — coach link 1 url
  - `coach_link_2_icon` string — coach link 2 icon
  - `coach_link_2_url` string — coach link 2 url
  - `coach_link_3_icon` string — coach link 3 icon
  - `coach_link_3_url` string — coach link 3 url
  - `coach_link_4_icon` string — coach link 4 icon
  - `coach_link_4_url` string — coach link 4 url
  - `coach_link_5_icon` string — coach link 5 icon
  - `coach_link_5_url` string — coach link 5 url
  - `next_class_reservation` string, date-time — Date and time of next (soonest in the future) Reservation in the Status of “Reserved”
  - `next_appointment_booking` string, date-time — Date and time of next (soonest in the future) Booking in the Status of “Reserved”
  - `coach_services` ServiceAPI[] — services a coach provides
    - `id` integer — Id of the Service
    - `name` string — Name of the service
    - `description` string — Description of the service
    - `service_icon_id` integer, required — Id of the Icon that represents the Service
    - `service_icon` string — Service Icon that represents the Service
    - `hex_color` string — Hex Color of the Service
    - `attendance_limit` integer — The number of Clients that attend an Appointment together for this Service
    - `has_free_intro_limit` boolean — True if Free Intro limit is enabled
    - `free_intro_limit` integer — Free Intro limit number
    - `durations` ServiceDurationAPI[] — Durations for the Service
      - `id` integer — Id of the ServiceDuration
      - `duration_hour` integer — Service duration - Hour value
      - `duration_minutes` integer — Service duration - Minutes value
    - `cancellation_policy` ServiceCancellationPolicyAPI — Data for the Cancellation Poilicy of a Service
      - `has_cancellation_policy` boolean — Defines if the Service has a cancellation policy for Bookings.
      - `cancellation_time_window` integer — The time window which Clients are able to cancel a Booking for the Service without penalty.
      - `cancellation_unit_of_time_id` integer — Unit of Time Id for the cancellation time window
      - `cancellation_unit_of_time` string — Unit of Time for the cancellation time window
      - `cancellation_has_loss_of_session` boolean — Defines if a late cancellation results in a loss of session
      - `cancellation_has_fee` boolean — Defines if a late cancellations results in a flat fee
      - `cancellation_fee` number — Cancellation flat fee value
      - `cancellation_fee_tax_rate_id` integer — Tax Rate Id applied to the cancellation fee
      - `cancellation_fee_tax_rate` string — Tax Rate applied to the cancellation fee
    - `no_show_policy` ServiceNoShowPolicyAPI — Data for the No-show Poilicy of a Service
      - `has_no_show_policy` boolean — Defines if the Service has a No-Show policy for Bookings.
      - `no_show_has_loss_of_session` boolean — Defines if a no-show results in a loss of session
      - `no_show_has_fee` boolean — Defines if a no-show results in a flat fee
      - `no_show_fee` number — No-show flat fee value
      - `no_show_fee_tax_rate_id` integer — Tax Rate Id applied to the no-show fee
      - `no_show_fee_tax_rate` string — Tax Rate applied to the no-show fee
    - `location_providers` ServiceLocationAPI[] — Locations and their Providers for the Service
      - `id` integer
      - `location_id` integer — Id of the Location for the Service
      - `location` string — Location for the Service
      - `show_in_simple_sign_in` boolean — True, will show the appointments of this service in Kiosk Simple Sign In
      - `providers` ServiceLocationProviderAPI[] — The providers for the given Service Location
        - `provider_id` integer — Provider Id of the Service
        - `provider` string — Provider of the Service
    - `bookings_open_time_window` integer — Window of time that bookings open for the Service
    - `bookings_open_time_window_unit_of_time_id` integer — Unit of Time Id for the Bookings Open Time Window
    - `bookings_open_time_window_unit_of_time` string — Unit of Time for the Bookings Open Time Window
    - `bookings_close_time_window` integer — Window of time that bookings close for the Service
    - `bookings_close_time_window_unit_of_time_id` integer — Unit of Time Id for the Bookings Closes Time Window
    - `bookings_close_time_window_unit_of_time` string — Unit of Time for the Bookings Close Time Window
    - `buffer_time` integer — Buffer Time between Appointments for the Service
    - `appointments_can_start_at_00` boolean — Indicates that the service can start at the beggining of the hour (minute 0)
    - `appointments_can_start_at_05` boolean — Indicates that the service can start at the minute 5
    - `appointments_can_start_at_10` boolean — Indicates that the service can start at the minute 10
    - `appointments_can_start_at_15` boolean — Indicates that the service can start at minute 15
    - `appointments_can_start_at_20` boolean — Indicates that the service can start at the minute 20
    - `appointments_can_start_at_25` boolean — Indicates that the service can start at the minute 25
    - `appointments_can_start_at_30` boolean — Indicates that the service can start at minute 30
    - `appointments_can_start_at_35` boolean — Indicates that the service can start at the minute 35
    - `appointments_can_start_at_40` boolean — Indicates that the service can start at the minute 40
    - `appointments_can_start_at_45` boolean — Indicates that the service can start at minute 45
    - `appointments_can_start_at_50` boolean — Indicates that the service can start at the minute 50
    - `appointments_can_start_at_55` boolean — Indicates that the service can start at the minute 55
    - `waivers` ServiceWaiverAPI[] — The Waivers applicable to the service
      - `waiver_id` integer — Id of the Waiver
      - `waiver` string — Name of the Waiver
    - `is_active` boolean — Determines if the Service is active
    - `created` Created — Record creation data.
      - `created_by_id` integer — Unique ID of the user that created the record.
      - `created_by` string — Name of the user that created the record.
      - `created_on_datetime` string, date-time — Datetime on which the record was created.
    - `updated` Updated — Update info
      - `updated_by_id` integer — Unique ID of the user that last updated the record.
      - `updated_by` string — Name of the user that most recently updated the record.
      - `updated_on_datetime` string, date-time — Datetime on which the record was last updated.
  - `coach_programs` ProgramAPI[] — list of programs a coach coaches
    - `program_id` integer — Program Id
    - `program` string — Program name
  - `coach_locations` LocationAPI[] — coach locations
    - `location_id` integer — Location Id
    - `location` string — Location name
  - `wodify_validation_result` string — Error message, if applicable

---

[API](https://skmtc.net/wodify/apis/leads.md) · [All operations](https://skmtc.net/wodify/apis/leads/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wodify/leads/revisions/974500ca0714/schema)