NameDescriptionTypeAdditional information
Method

Indicates communication method.

string

None.

PatientExternalID

Patient's unique ID on integrating system.

string

None.

UpdateAllowEmailTo

Indicates whether the patient agrees to receive email communications (in general) or not.

boolean

None.

UpdateAllowEmailRemindersTo

Indicates whether the patient agrees to receive email reminders or not.

boolean

None.

UpdateAllowEmailBirthdayTo

Indicates whether the patient agrees to receive birthday email communications or not.

boolean

None.

UpdateAllowEmailThankYouTo

Indicates whether the patient agrees to receive thank you email communications or not.

boolean

None.

UpdateAllowEmailEyewearTo

Indicates whether the patient agrees to receive eyewear email communications or not.

boolean

None.

UpdateAllowEmailPromotionsTo

Indicates whether the patient agrees to receive email promotions or not.

boolean

None.

UpdateEmailAddressAliasTo

Indicates the new email address alias.

string

None.

UpdateEmailAddressTo

Indicates the new email address.

string

None.

UpdateAllowSmsTo

Indicates whether the patient agrees to receive text communications (in general) or not.

boolean

None.

UpdateAllowSmsRemindersTo

Indicates whether the patient agrees to receive text reminders or not.

boolean

None.

UpdateAllowSmsBirthdayTo

Indicates whether the patient agrees to receive birthday text communications or not.

boolean

None.

UpdateAllowSmsThankYouTo

Indicates whether the patient agrees to receive thank you text communications or not.

boolean

None.

UpdateAllowSmsEyewearTo

Indicates whether the patient agrees to receive eyewear text communications or not.

boolean

None.

UpdateAllowSmsPromotionsTo

Indicates whether the patient agrees to receive text promotions or not.

boolean

None.

UpdateSmsPhoneAliasTo

Indicates the new sms phone alias.

string

None.

UpdateSmsPhoneTo

Indicates the new sms phone.

string

None.

UpdateAllowVoiceTo

Indicates whether the patient agrees to receive voice communications (in general) or not.

boolean

None.

UpdateAllowVoiceRemindersTo

Indicates whether the patient agrees to receive voice reminders or not.

boolean

None.

UpdateAllowVoiceBirthdayTo

Indicates whether the patient agrees to receive birthday voice communications or not.

boolean

None.

UpdateAllowVoiceThankYouTo

Indicates whether the patient agrees to receive thank you voice communications or not.

boolean

None.

UpdateAllowVoiceEyewearTo

Indicates whether the patient agrees to receive eyewear voice communications or not.

boolean

None.

UpdateAllowVoicePromotionsTo

Indicates whether the patient agrees to receive voice promotions or not.

boolean

None.

UpdateVoicePhoneAliasTo

Indicates the new voice phone alias.

string

None.

UpdateVoicePhoneTo

Indicates the new voice phone.

string

None.

RecallContactLater

Indicates if the patient wants to be contacted later about a recall.

boolean

None.

ContactLensesContactLater

Indicates if the patient wants to be contacted later about buying contact lenses.

boolean

None.

PatientUpdateID

Unique ID of the model. ID belongs to the patient.

globally unique identifier

None.