latestOpenAPI 3.1.12026-08-198571,0002.4 MB
d8d7501dde48
Clients
post/Clients
Request body
emailstring nullable
firstNamestring
lastNamestring
phoneNumberstring nullable
addressstring nullable
citystring nullable
statestring nullable
zipCodestring nullable
countryCodestring nullable
dateOfBirthstring date-time nullable
accountStatusstring nullable
preferredContactMethodstring nullable
allowAppointmentRemindersboolean
allowEmailMarketingboolean
allowPhoneCallsboolean
allowSmsMarketingboolean
communicationNotesstring nullable
emergencyContactNamestring nullable
emergencyContactPhonestring nullable
emergencyContactEmailstring nullable
emergencyContactRelationshipstring nullable
secondaryEmergencyContactNamestring nullable
secondaryEmergencyContactPhonestring nullable
secondaryEmergencyContactEmailstring nullable
secondaryEmergencyContactRelationshipstring nullable
preferredLanguagestring nullable
referralSourcestring nullable
Marketing attribution — "how did you hear about us".
createdViastring nullable
Provenance, for system callers that create clients on a client's behalf (widget booking, record import). Leave null for staff-entered clients.
Response
OK
idstring
emailstring nullable
phoneNumberstring nullable
firstNamestring
lastNamestring
addressstring nullable
citystring nullable
statestring nullable
zipCodestring nullable
countryCodestring nullable
ISO 3166-1 alpha-2 country code (e.g. "US", "GB"). Defaults to clinic's region if null.
dateOfBirthstring date-time nullable
accountStatusinteger
preferredLanguagestring nullable
referralSourcestring nullable
Marketing attribution — "how did you hear about us". Staff/client entered.
createdViastring nullable
Read-only provenance — the channel that created the record (ITE-419).
createdAtstring date-time
updatedAtstring date-time