RelationshipUpdate
extends BaseComponent
in package
Table of Contents
Properties
- $comments : string|null
- $do_not_contact : bool|null
- $give_parental_access : bool|null
- $list_as_parent : bool|null
- $primary : bool
- $resides_with : bool|null
- $tuition_responsible_signer : bool|null
- $fields : array<string|int, string>
Properties
$comments
public
string|null
$comments
The comment for the relationship.
$do_not_contact
public
bool|null
$do_not_contact
Set to true to indicate the relationship user (specified by left_user) should not be contacted. Defaults to false.
$give_parental_access
public
bool|null
$give_parental_access
Set to true if the parent user should have parental access for the child user. Defaults to false. Used only for Parent/Child relationship.
$list_as_parent
public
bool|null
$list_as_parent
Set to true if the parent user should be listed as a parent of the child user. Defaults to false. Used only for Parent/Child relationship.
$primary
public
bool
$primary
Set to true if the relationship user (specified by left_user) is the primary contact. Defaults to false. When set to true, this will set primary for the current primary relationship to false.
$resides_with
public
bool|null
$resides_with
Set to true if the child user resides with the parent user. Defaults to false. Used only for Parent/Child relationship.
$tuition_responsible_signer
public
bool|null
$tuition_responsible_signer
Set to true if the parent user is a responsible signer for the child user. Defaults to false. Used only for Parent/Child relationship.
$fields
protected
static array<string|int, string>
$fields
= ["give_parental_access" => "bool", "list_as_parent" => "bool", "tuition_responsible_signer" => "bool", "resides_with" => "bool", "do_not_contact" => "bool", "primary" => "bool", "comments" => "string"]