Skip to content

Family Member

FieldTypeIndexRequiredDescription
entityIdstringPKYThe Member Id from the third-party system will be used in the Cloud to determine whether to update an existing Family member record or create a new one.
familyEntityIdstringFKYThe entityId to family model
firstNamestringY
lastNamestringY
middleInitialstringY
dobstringThe date of birth, yyyyMMdd.
genderstringYsuch as male, female,
emailstring
phonestringdefault cell phone
phone2stringdefault work phone
addressobjectaddress
mailAddressobjectaddress object
sameAddressbool
ethnicitystringThe ethnicity of the family member is either hispanic-latino, no-hispanic-latino
racestringThe race of the family member is either caucasian, asian, american-indian, black, pacific-islander, other,
citizenInfostring
includeInSizeboolindicates whether a family member is included in the calculation of the family size.
statusstringYThe status of the family member is either new, pending, active, inactive, void.
isParentboolY
isChildboolY
primaryParentboolYtrue is Parent A
minorParentboolY
ssnstring
languagestringSupported code is either en: English es: Spanish zh: Chinese.
limitedEnglishbool
relationshipstringsuch as son, daughter, father, mother, foster-child, grandparent, guardian,other,
commentstring
dataobjectCustom data objects can include additional Family member attributes, with field definitions adhering to established guidelines.
disabledboolY
tagsarraystring array
categorystring
metadataobjectset of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
FieldTypeDescription
isProtectiveServicebool
countyChildIdstring
specialNeedstring
cpsAtRiskstring
schoolstring
customerFieldsobjectSet of key-value pairs that you can attach to an object
FieldTypeDescription
countyParentIdstring
familyAppbooltrue is linked family portal
portalAccountstringlogon name
trainingStartDatestringyyyyMMdd
trainingEndDatestringyyyyMMdd
customerFieldsobjectSet of key-value pairs that you can attach to an object