CLclinicos
Clients

POST /Clients

Changed on

Request

Request body

emailstring nullable
firstNamestring
lastNamestring
phoneNumberstring nullable
addressstring nullable
addressLine2string nullable

Apartment / suite / unit. Second address line.

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
addressLine2string nullable

Apartment / suite / unit. Second address line.

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
emailSuppressedAtstring date-time nullable

When email to this client stopped being sent because SES reported a spam complaint or a permanent bounce. Null = deliverable. Cleared by changing the email address.

emailSuppressionReasonstring nullable

"Complaint" or "PermanentBounce"; null when not suppressed.

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).

registrationPendingboolean

Placeholder owner created by emergency intake whose details have not been completed.

allowHouseAccountboolean

House account (ITE-670): approved to charge invoices to their account. Changed only via PUT /clients/{id}/house-account (settings permission).

createdAtstring date-time
updatedAtstring date-time

Changes

  • 099cf36186e0Revision changes
    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

  • 021fabd866ffRevision changes
    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)