Skip to content

updateClientInput

Autogenerated input type of updateClient

Fields

deprecated DO NOT USE
active · Boolean · Whether the user is active.
activity_level · String · The activity level of the user (used in BMR calculations).
additional_phone_number · String · An additional phone number.
additional_record_identifier · ID · An additional record identifier.
advance_appointment_prices · [AdvanceAppointmentPriceInput] · Custom appointment prices per appointment type.
appointment_type_credits_attributes · [AppointmentTypeCreditInput] · Booking credits for specific appointment types.
auto_charge_enabled · Boolean · Whether automatic charging is enabled.
client_source · ClientSourceInput · The source that referred the user.
current_email · String · The user's current email address, used to look up the user instead of the id field.
diagnoses · [DiagnosesInput] · The diagnoses associated with the user.
dietitian_id · ID · The ID of the provider assigned to this user.
dob · String · The user's date of birth.
email · String · The user's email address.
first_name · String · The user's first name.
for_changing_groups · Boolean · When true and user_group_id is nil, removes the user from their current group.
gender · String · The user's gender.
gender_identity · ID · The user's gender identity.
gender_identity_code · ID · Code representing the user's gender identity.
height · String · The user's height.
default_dosespot_clinic_id · String · The default Dosespot Clinic ID to use for a patient. Commonly nil, in which case the provider's default is used.
id · ID · The ID of the user to update.
is_intake_item · Boolean · When true, indicates the form reminder is for an intake item.
last_name · String · The user's last name.
legal_name · String · The user's legal first name.
location · ClientLocationInput · The user's primary location.
locations · [ClientLocationInput] · The user's locations.
metadata · String · A serialized JSON string of metadata. Maximum length is 128000.
deprecated Deprecated
other_provider_ids · [ID] · IDs of additional providers connected to the user (i.e. care team members).
password · String · The user's password.
phone_number · String · The user's phone number.
policies · [ClientPolicyInput] · The user's insurance policies.
preferred_language_code · String · The user's preferred language code.
primary_ethnicity_code · String · The user's primary ethnicity code.
primary_race_code · String · The user's primary race code.
pronouns · String · The user's pronouns.
quick_notes · String · Brief notes about the user visible to the provider.
record_identifier · ID · A unique record identifier.
referrals · [ReferralInput] · The user's referrals.
remove_card_on_file · Boolean · When true, removes the user's saved payment card.
requested_form_completion_id · ID · The ID of a specific requested form completion to remind the user about.
resend_welcome · Boolean · When true, re-sends the welcome email to the user.
restricted · Boolean · Restricted is only available when enabled for an organization.
secondary_ethnicity_code · String · The user's secondary ethnicity code.
secondary_race_code · String · The user's secondary race code.
send_form_request_reminder · Boolean · When true, sends a reminder email for a requested form completion.
sex · String · The user's biological sex.
sexual_orientation_code · String · The user's sexual orientation code.
sexual_orientation_other · String · A custom description of the user's sexual orientation when 'other' is selected.
skipped_email · Boolean · Whether the user does not have a real email address.
ssn · String · The social security number of the patient.
timezone · String · The user's timezone.
token · String · A credit card token generated by Stripe.
user_group_id · ID · The ID of the user group to assign the user to.

Used By

Definition

"""
Autogenerated input type of updateClient
"""
input updateClientInput {
"""
DO NOT USE
"""
clientMutationId: String @deprecated(reason: "DO NOT USE")
"""
Whether the user is active.
"""
active: Boolean
"""
The activity level of the user (used in BMR calculations).
"""
activity_level: String
"""
An additional phone number.
"""
additional_phone_number: String
"""
An additional record identifier.
"""
additional_record_identifier: ID
"""
Custom appointment prices per appointment type.
"""
advance_appointment_prices: [AdvanceAppointmentPriceInput]
"""
Booking credits for specific appointment types.
"""
appointment_type_credits_attributes: [AppointmentTypeCreditInput]
"""
Whether automatic charging is enabled.
"""
auto_charge_enabled: Boolean
"""
The source that referred the user.
"""
client_source: ClientSourceInput
"""
The user's current email address, used to look up the user instead of the id field.
"""
current_email: String
"""
The diagnoses associated with the user.
"""
diagnoses: [DiagnosesInput]
"""
The ID of the provider assigned to this user.
"""
dietitian_id: ID
"""
The user's date of birth.
"""
dob: String
"""
The user's email address.
"""
email: String
"""
The user's first name.
"""
first_name: String
"""
When true and user_group_id is nil, removes the user from their current group.
"""
for_changing_groups: Boolean
"""
The user's gender.
"""
gender: String
"""
The user's gender identity.
"""
gender_identity: ID
"""
Code representing the user's gender identity.
"""
gender_identity_code: ID
"""
The user's height.
"""
height: String
"""
The default Dosespot Clinic ID to use for a patient. Commonly nil, in which case the provider's default is used.
"""
default_dosespot_clinic_id: String
"""
The ID of the user to update.
"""
id: ID
"""
When true, indicates the form reminder is for an intake item.
"""
is_intake_item: Boolean
"""
The user's last name.
"""
last_name: String
"""
The user's legal first name.
"""
legal_name: String
"""
The user's primary location.
"""
location: ClientLocationInput
"""
The user's locations.
"""
locations: [ClientLocationInput]
"""
A serialized JSON string of metadata. Maximum length is 128000.
"""
metadata: String
"""
Notification contacts.
"""
notification_contacts: [NotificationContactInput]
@deprecated(reason: "Deprecated")
"""
IDs of additional providers connected to the user (i.e. care team members).
"""
other_provider_ids: [ID]
"""
The user's password.
"""
password: String
"""
The user's phone number.
"""
phone_number: String
"""
The user's insurance policies.
"""
policies: [ClientPolicyInput]
"""
The user's preferred language code.
"""
preferred_language_code: String
"""
The user's primary ethnicity code.
"""
primary_ethnicity_code: String
"""
The user's primary race code.
"""
primary_race_code: String
"""
The user's pronouns.
"""
pronouns: String
"""
Brief notes about the user visible to the provider.
"""
quick_notes: String
"""
A unique record identifier.
"""
record_identifier: ID
"""
The user's referrals.
"""
referrals: [ReferralInput]
"""
When true, removes the user's saved payment card.
"""
remove_card_on_file: Boolean
"""
The ID of a specific requested form completion to remind the user about.
"""
requested_form_completion_id: ID
"""
When true, re-sends the welcome email to the user.
"""
resend_welcome: Boolean
"""
Restricted is only available when enabled for an organization.
"""
restricted: Boolean
"""
The user's secondary ethnicity code.
"""
secondary_ethnicity_code: String
"""
The user's secondary race code.
"""
secondary_race_code: String
"""
When true, sends a reminder email for a requested form completion.
"""
send_form_request_reminder: Boolean
"""
The user's biological sex.
"""
sex: String
"""
The user's sexual orientation code.
"""
sexual_orientation_code: String
"""
A custom description of the user's sexual orientation when 'other' is selected.
"""
sexual_orientation_other: String
"""
Whether the user does not have a real email address.
"""
skipped_email: Boolean
"""
The social security number of the patient.
"""
ssn: String
"""
The user's timezone.
"""
timezone: String
"""
A credit card token generated by Stripe.
"""
token: String
"""
The ID of the user group to assign the user to.
"""
user_group_id: ID
}