create_child
This call creates a child in a family system. This is very similar to create, but connected_to is mandatory and must be the same as clogin_id for the associated parent.
Name | Type | Required | Description |
|---|---|---|---|
action | string | true | create_child |
clogin_id | integer | false | This is a central login id which identifies a user within your organization. Organizations can have multiple projects that the same user can register in. If you know the clogin_id from a separate project, you can use it to connect the accounts. clogin_id should be false for a user who is being created for the first time within your organization. |
group_id | integer | true | This designates which project the action should be applied towards. |
connected_to | integer | true | This is the clogin_id of the parent you are trying to add a child to. |
doc | array | true | See doc parameters below. If no information is needed, an empty doc must still be provided. |
submit_forms | boolean | false | This disables emails from sending as a result of triggers. |
disable_email_sending | boolean | false | This prevents all forms from submitting, which often triggers actions to occur. |
Name | Type | Required | Description |
|---|---|---|---|
first_name | string | false | This is an important field which is responsible for the presentation of the first name on the user management page. It is strongly advised that this is included. |
last_name | string | false | This functions like first_name |
org_name | string | false | Similar to first_name, but allows an organization name to display on the user management page. Note that in a family system, it is still advised that first_name and last_name are included in addition to org_name. |
main_email | string | false | This is similar to first_name, and often serves as username as well. Note that emails are both validated and checked against a DNS database, however the DNS check can be disabled in the project settings of your project. |
_application_date | string | false | This will default to the creation date if not supplied. This is included in case you want to back-date an applicant's creation date. Should be formatted like "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss". |
_prevent_duplicate | logical | false | This tries to find the user within the family to see if any member has the same email or the same combination of first_name and last_name. The default is true. |
fields | string | false | These are the fields in your project, such as multiple choice fields, short answer fields, etc... See "Referencing fields in API calls" for more information on how to supply fields in the API. |
This is an example that would create a new child. The key things to note are that main_email, first_name, and last_name are all supplied while clogin_id is false. Altogether, this is the equivalent of a parent registering a child and answering the yes/no question.
