| appointment_gender_preference |
string |
The gender of staff member with whom the client prefers to book appointments. |
[optional] |
| birth_date |
\DateTime |
The client’s date of birth. |
[optional] |
| country |
string |
The client’s country. |
[optional] |
| creation_date |
\DateTime |
The date the client’s profile was created and added to the business, either by the client from the online store, or by a staff member. This value always returns in the format `yyyy-mm-ddThh:mm:ss:ms`. |
[optional] |
| custom_client_fields |
\Swagger\Client\Model\CustomClientFieldValue[] |
Contains information about the custom client fields assigned to the client. |
[optional] |
| client_credit_card |
\Swagger\Client\Model\ClientCreditCard |
Contains information about the client’s credit card. |
[optional] |
| client_indexes |
\Swagger\Client\Model\AssignedClientIndex[] |
Contains the IDs of the client’s assigned ClientIndexes and ClientIndexValues. |
[optional] |
| client_relationships |
\Swagger\Client\Model\ClientRelationship[] |
Contains information about the relationship between two clients. |
[optional] |
| first_appointment_date |
\DateTime |
The date of the client’s first booked appointment at the business. |
[optional] |
| first_name |
string |
The client’s first name. |
[optional] |
| id |
string |
The client’s ID, as configured by the business owner. This is the client’s barcode ID if the business owner assigns barcodes to clients. This ID is used throughout the Public API for client-related Public API calls. When used in a POST `UpdateClient` request, the `Id` is used to identify the client for the update. |
[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_name |
string |
The client’s last name. |
[optional] |
| liability |
\Swagger\Client\Model\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] |
| mobile_provider |
int |
The client’s mobile provider. |
[optional] |
| notes |
string |
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] |
| state |
string |
The client’s state. |
[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] |
| last_modified_date_time |
\DateTime |
The UTC date and time when the client’s information was last modified. |
[optional] |
| red_alert |
string |
Contains any red alert information entered by the business owner for the client. |
[optional] |
| yellow_alert |
string |
Contains any yellow alert information entered by the business owner for the client. |
[optional] |
| middle_name |
string |
The client’s middle name. |
[optional] |
| prospect_stage |
\Swagger\Client\Model\ProspectStage |
Contains information about the client prospect stage. |
[optional] |
| email |
string |
The client’s email address. |
[optional] |
| mobile_phone |
string |
The client’s mobile phone number. |
[optional] |
| home_phone |
string |
The client’s home phone number. |
[optional] |
| work_phone |
string |
The client’s work phone number. |
[optional] |
| account_balance |
double |
The client’s current account balance. |
[optional] |
| address_line1 |
string |
The first line of the client’s street address. |
[optional] |
| address_line2 |
string |
The second line of the client’s street address, if needed. |
[optional] |
| city |
string |
The client’s city. |
[optional] |
| postal_code |
string |
The client’s postal code. |
[optional] |
| work_extension |
string |
The client’s work phone extension number. |
[optional] |
| referred_by |
string |
Specifies how the client was referred to the business. You can get a list of possible strings using the `GetClientReferralTypes` endpoint. |
[optional] |
| photo_url |
string |
The URL of the client’s photo for the client profile. |
[optional] |
| emergency_contact_info_name |
string |
The name of the client’s emergency contact. |
[optional] |
| emergency_contact_info_email |
string |
The email address of the client’s emergency contact. |
[optional] |
| emergency_contact_info_phone |
string |
The phone number of the client’s emergency contact. |
[optional] |
| emergency_contact_info_relationship |
string |
The client’s relationship with the emergency contact. |
[optional] |
| gender |
string |
The gender of the client. |
[optional] |
| last_formula_notes |
string |
The last formula note entered for the client. |
[optional] |
| active |
bool |
When `true`, indicates that the client’s profile is marked as active on the site.<br /> When `false`, the client’s profile is inactive. |
[optional] |
| sales_reps |
\Swagger\Client\Model\SalesRep[] |
A list of sales representatives. |
[optional] |
| status |
string |
The status of the client in the business. Possible values are: * Declined * Non-Member * Active * Expired * Suspended * Terminated |
[optional] |
| action |
string |
The action taken. |
[optional] |
| send_account_emails |
bool |
When `true`, indicates that the client has opted to receive general account notifications by email. This property is editable. <br />Default: false |
[optional] |
| send_account_texts |
bool |
When `true`, indicates that the client has opted to receive general account notifications by text message. This parameter cannot be updated by developers. If included in a request, it is ignored. |
[optional] |
| send_promotional_emails |
bool |
When `true`, indicates that the client has opted to receive promotional notifications by email. This property is editable. <br />Default: false |
[optional] |
| send_promotional_texts |
bool |
When `true`, indicates that the client has opted to receive promotional notifications by text message. This parameter cannot be updated by developers. If included in a request, it is ignored. |
[optional] |
| send_schedule_emails |
bool |
When `true`, indicates that the client has opted to receive schedule notifications by email. This property is editable. <br />Default: false |
[optional] |
| send_schedule_texts |
bool |
When `true`, indicates that the client has opted to receive schedule notifications by text message. This parameter cannot be updated by developers. If included in a request, it is ignored. |
[optional] |