| account_balance |
float |
The client’s current account balance. |
[optional] |
| action |
str |
The action taken. |
[optional] |
| active |
bool |
When `true`, indicates that the client is active at the site.<br /> When `false`, indicates that the client is not active at the site. |
[optional] |
| address_line1 |
str |
The first line of the client’s street address. |
[optional] |
| address_line2 |
str |
The second line of the client’s street address, if needed. |
[optional] |
| appt_gender_pref_male |
bool |
When `true`, indicates that the client prefers services to be provided by a male service provider.<br /> When `false`, indicates that the client prefers services to be provided by a female service provider.<br /> When `null`, indicates that the client has no preference. Default: null |
[optional] |
| birth_date |
datetime |
The client’s date of birth. |
[optional] |
| city |
str |
The client’s city. |
[optional] |
| client_credit_card |
ClientCreditCard |
Contains information about the client’s credit card. |
[optional] |
| client_indexes |
list[AssignedClientIndex] |
Contains a list of the indexes and client index values to be assigned to the client. |
[optional] |
| client_relationships |
list[ClientRelationship] |
Contains information about client relationships to be assigned to the client. |
[optional] |
| country |
str |
The country in which the client is located. |
[optional] |
| creation_date |
datetime |
The date when the client was added to the business, either by the client from the online store or by a staff member at the subscriber’s business. This value always returns in the format yyyy-mm-ddThh:mm:ss:ms. |
[optional] |
| custom_client_fields |
list[CustomClientFieldValue] |
Contains information about the custom fields to be assigned to the client. |
[optional] |
| email |
str |
The client’s email address. |
[optional] |
| emergency_contact_info_email |
str |
The email address of the client’s emergency contact.<br /> For more information, see Children’s program features(emergency contact information). |
[optional] |
| emergency_contact_info_name |
str |
The name of the client’s emergency contact. |
[optional] |
| emergency_contact_info_phone |
str |
The phone number of the client’s emergency contact. |
[optional] |
| emergency_contact_info_relationship |
str |
The client’s relationship with the emergency contact, for example, mother or spouse. |
[optional] |
| first_appointment_date |
datetime |
The date of the client’s first booked appointment at the business. |
[optional] |
| first_name |
str |
The client’s first name. You must specify a first name when you add a client. |
|
| gender |
str |
The client’s gender. |
[optional] |
| home_location |
Location |
Sets the client’s home location to the passed location, based on its ID. |
[optional] |
| home_phone |
str |
The client’s home phone number. |
[optional] |
| is_company |
bool |
When `true`, indicates that the client should be marked as a company at the business.<br /> When `false`, indicates the client is an individual and does not represent a company. |
[optional] |
| is_prospect |
bool |
This value is set only if the business owner allows individuals to be prospects.<br /> When `true`, indicates that the client should be marked as a prospect for the business.<br /> When `false`, indicates that the client should not be marked as a prospect for the business. |
[optional] |
| last_formula_notes |
str |
The last formula note entered for the client. |
[optional] |
| last_modified_date_time |
datetime |
The UTC date and time when the client’s information was last modified. |
[optional] |
| last_name |
str |
The client’s last name. You must specify a last name when you add a client. |
|
| liability |
Liability |
Contains the client’s liability agreement information for the business. |
[optional] |
| liability_release |
bool |
Passing `true` sets the client’s liability information as follows: * `IsReleased` is set to `true`. * `AgreementDate` is set to the time zone of the business when the call was processed. * `ReleasedBy` is set to `null` if the call is made by the client, `0` if the call was made by the business owner, or to a specific staff member’s ID if a staff member made the call. Passing `false` sets the client’s liability information as follows: * `IsReleased` is set to `false`. * `AgreementDate` is set to `null`. * `ReleasedBy` is set to `null`. |
[optional] |
| membership_icon |
int |
The ID of the membership icon displayed next to the client’s name, if the client has a membership on their account. |
[optional] |
| middle_name |
str |
The client’s middle name. |
[optional] |
| mobile_phone |
str |
The client’s mobile phone number. |
[optional] |
| mobile_provider |
int |
The client's mobile provider. |
[optional] |
| new_id |
str |
When passed, sets the client's ID to this value. Otherwise, the client's ID will match their `UniqueId`. |
[optional] |
| notes |
str |
Any notes entered on the client’s account by staff members. This value should never be shown to clients unless the business owner has a specific reason for showing them. |
[optional] |
| photo_url |
str |
The URL for the client’s photo, if one has been uploaded. |
[optional] |
| postal_code |
str |
The client’s postal code. |
[optional] |
| prospect_stage |
ProspectStage |
Contains information about the client prospect stage. |
[optional] |
| red_alert |
str |
Contains any red alert information entered by the business owner for the client. |
[optional] |
| referred_by |
str |
Specifies how the client was referred to the business. You can get a list of possible strings using the `GET ClientReferralTypes` endpoint.<br /> For more information, see Referral types and referral subtypes. |
[optional] |
| sales_reps |
list[SalesRep] |
Contains information about the sales representatives to be assigned to the new client. |
[optional] |
| site_id |
int |
The ID of the site. |
[optional] |
| state |
str |
The client’s state. |
[optional] |
| status |
str |
The client’s status. |
[optional] |
| test |
bool |
When `true`, indicates that test mode is enabled. The method is validated, but no client data is added or updated.<br /> Default: false |
[optional] |
| unique_id |
int |
The client’s system-generated ID at the business. This value cannot be changed by business owners and is always unique across all clients at the business. This ID is not widely used in the Public API, but can be used by your application to uniquely identify clients. |
[optional] |
| work_extension |
str |
The client’s work phone extension number. |
[optional] |
| work_phone |
str |
The client’s work phone number. |
[optional] |
| yellow_alert |
str |
Contains any yellow alert information entered by the business owner for the client. |
[optional] |
| send_schedule_emails |
bool |
When `true`, indicates that the client opts to receive schedule emails. |
[optional] |
| send_account_emails |
bool |
When `true`, indicates that the client opts to receive account emails. |
[optional] |
| send_promotional_emails |
bool |
When `true`, indicates that the client opts to receive promotional emails. |
[optional] |