ARE YOU USING SOMEONE ELSE'S SOFTWARE?
We'll give you $120 credit to switch to Bizstim!
Bizstim Business Software BOOK DEMO
TERMS & CONDITIONS:
  • at least 3 months with the other company
  • provide a screenshot of your billing history
  • purchase a paid subscription with us
  • when verified we'll add $120 credit to your account
  • you can stack our 3 months at 50%-OFF offer
  • not available to returning accounts

API Documentation

PUT: UPDATE CLIENT

Type: PUT
Method: client
Parameter: (integer) {client_id}
URL Examples:
https://www.bizstim.com/api/client/505

You can update any of the request body parameters listed below. You DO NOT have to make them all available with your PUT request.

ELEMENT TYPE DESCRIPTION
first_name string First name for the client
last_name string Last name for the client
address1 string Street address for the client
address2 string Suite or appartment number for the client
city string City location for the client
state string State location for the client
zipcode string Zipcode location for the client
country string Country location for the client
p_phone string Primary phone number for the client
s_phone string Secondary phone number for the client
text_phone string Text message phone number for the client. Comma separated list of mobile numbers
latitude string Geogrpahic co-ordinate
longitude string Geogrpahic co-ordinate
dob string Date of Birth (YYYY-MM-DD)
status string active, inactive, prospect
inactive_date string Date the client was marked inactive (YYYY-MM-DD)
inactive_set_date string Date the client will be marked inactive (YYYY-MM-DD)
inactive_reason string The reason for being marked inactive
inactive_who string First and last name of the user who marked the client inactive
funnel_id integer Unique id. id on the client_settings table
calendar_color string hexadecimal color code for the calendar cell color. This is over-rided if the open-closed color scheme is selected for the calendar by the administrator
start_date string The date the client began services (YYYY-MM-DD)
notes string Notes for the client
timezone string IANA time zone format e.g. "America/Los_Angeles"
send_welcome_message integer 0 = no, 1 = yes
send_lesson_reminders integer 0 = no, 1 = yes
add_session integer 0 = no, 1 = yes
see_practs_information integer 0 = no, 1 = yes
text_reminders integer 0 = no, 1 = yes
use_records integer 0 = no, 1 = yes
session_cancel integer 0 = no, 1 = yes
ace integer Available credit exception. 0 = no, 1 = yes
hide costs integer Hide costs from the client. 0 = no, 1 = yes
username string Username string: not case sensitive. The username must be unique.
email string String of comma separated emails: e.g. email1@mail.com,email2@mail.com
dark integer 0 = light mode, 1 = dark mode
calendar integer 1 = month, 2 = week, 3 = day
minTime string Default = 08:00:00
maxTime string Default = 24:00:00
slotDuration string Default = 00:15:00 or 15 minute intervals
sessionLimit integer Number of sessions to show per day in month view. Default = 10
cal_length integer Length of the calendar on the page in pixels. Default = 1200
{
    "status": "success",
    "response": "The client record was updated successfully."
    "code": 6,
}
HTTP Response:
ELEMENT TYPE DESCRIPTION
status string success or failure
response string

Possible responses are:

  • (1) No request body parameters provided. | 400
  • (2) The client record could not be found. | 404
  • (3) The username is not unique. | 400
  • (4) One or more of the request body parameters are incorrect. | 400
  • (5) Unable to update the client record. | 500
  • (6) The client record was updated successfully. | 200