Swagger 2.02026-08-08115129199.5 KB
65d3a27fcb1a
Client
Create a new client
Create a new client
post/clients
Query parameters
partner_idstring
ID
client_type'MyClient::Client' | 'MyClient::Lead'
Client type
first_namestring required
First name
last_namestring
Last name
mobile_phonestring
Mobile Phone
work_phonestring
Work Phone
emailstring
ignore_custom_required_fieldsboolean
Skip the required custom fields validations
source_quick_addboolean
Was the client added through a quick add?
can_receive_automated_emailsboolean
Can receive automated emails
can_receive_automated_smsboolean
Can receive automated SMS
can_receive_manual_emailsboolean
Can receive manual emails
can_receive_manual_smsboolean
Can receive manual sms
can_receive_manual_sms_confirmed_atstring date-time
When was can_receive_manual_sms confirmed by double sms opt in
can_receive_automated_sms_confirmed_atstring date-time
When was can_receive_automated_sms confirmed by double sms opt in
add_label_namesstring[]
List of labels to add to the client
contact_preferenceinteger
Contact Preference. Email = 0, Home Phone = 1, Work Phone = 2, Text Message = 3, Mobile Phone = 4
preferred_location_partner_idstring
Preferred location partner id
preferred_location_mytime_idstring
Preferred location mytime id
associated_location_partner_idsstring[]
Associated location partner id
associated_location_mytime_idsstring[]
Associated location mytime id
Headers
X-Subdomainstring
Merchant subdomain - Optional
Request body
Response
— unresolved $ref