Browse the tools
Life event vocabulary
A life event is something that happened on a date, often with other people, such as a wedding, a move or a new job. A life event type names that kind of thing, sorted into categories, and carries the fields you fill in each time.
Tools
List the categories the account files its kinds of life event under.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many categories a page holds: 25 unless asked, 100 at most.
Read one category of life event types: its name, position, whether it is offered, whether it came with the account and how many types it holds.
-
life_event_categorystringrequired - The id of the category, as list-life-event-categories gives it.
List the kinds of life event filed under one category, in the order they are offered.
-
life_event_categorystringrequired - The id of the category, as list-life-event-categories gives it.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many life event types a page holds: 25 unless asked, 100 at most.
List the kinds of life event the account can record, such as Moved house or Started a job, sorted by category.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many life event types a page holds: 25 unless asked, 100 at most.
Read one kind of life event: its name, description, icon, colour, category, position, whether it is offered and whether it came with the account.
-
life_event_typestringrequired - The id of the life event type, as list-life-event-types gives it.
Read the fields a kind of life event asks for, in their groups, with the key that identifies each field. The fields nobody grouped come first.
-
life_event_typestringrequired - The id of the life event type, as list-life-event-types gives it.
Create a kind of life event, such as Ran a marathon, in one of the account’s categories. Give it fields of its own with replace-life-event-type-fields. The change is written to the account log.
-
life_event_category_idstringrequired - The id of the category, as list-life-event-categories gives it.
-
namestringrequired - The name of the kind of life event, such as Ran a marathon.
-
descriptionstringoptional - A sentence saying what it is for.
-
iconstringoptional -
The icon shown next to it.
One of:
profile,people,note,relationship,family,timeline,calendar,reminder,tasks,memory,journal,file,mail,phone,place,home,briefcase,organization,graduation,health,activity,ball,food,gift,pet,plane,globe,book,music,coin,car,target,tag,heart,star,lock,layers -
colourstringoptional -
The colour it is drawn in.
One of:
#3f5fd0,#4f8a49,#9a6a24,#9a3f2b,#6b4fa8,#2f7f86,#a8447a,#4a4a52 -
updates_last_in_touchbooleanoptional - Whether its life events set Last in touch on the contacts they are recorded with. Defaults to true.
Rename a kind of life event, change its description, icon or colour, or move it to another category. Whether it is offered changes with set-life-event-type-activation. The change is written to the account log.
-
life_event_typestringrequired - The id of the life event type, as list-life-event-types gives it.
-
life_event_category_idstringoptional - The id of the category to move it to, as list-life-event-categories gives it.
-
namestringoptional - The new name.
-
descriptionstringoptional - A sentence saying what it is for.
-
iconstringoptional -
The icon shown next to it.
One of:
profile,people,note,relationship,family,timeline,calendar,reminder,tasks,memory,journal,file,mail,phone,place,home,briefcase,organization,graduation,health,activity,ball,food,gift,pet,plane,globe,book,music,coin,car,target,tag,heart,star,lock,layers -
colourstringoptional -
The colour it is drawn in.
One of:
#3f5fd0,#4f8a49,#9a6a24,#9a3f2b,#6b4fa8,#2f7f86,#a8447a,#4a4a52 -
updates_last_in_touchbooleanoptional - Whether its life events set Last in touch on the contacts they are recorded with. Changing it works the date out again for everybody who took part in one.
Offer a kind of life event when somebody records one, or stop offering it. Life events already recorded with it stay. The change is written to the account log.
-
life_event_typestringrequired - The id of the life event type, as list-life-event-types gives it.
-
is_activebooleanrequired - True to offer it, false to stop offering it.
Move a kind of life event to another place within its category. The change is written to the account log.
-
life_event_typestringrequired - The id of the life event type, as list-life-event-types gives it.
-
positionintegerrequired - Where it goes within its category, counting from 1.
Replace the groups of fields, the fields nobody grouped, or both, that a kind of life event asks for. Each of groups and fields that is sent replaces what was there, and each that is left out keeps what it holds. A field sent with its key keeps its identity, and a field missing from a list that is sent is no longer asked for. Life events already recorded keep what they were written with. The change is written to the account log.
-
life_event_typestringrequired - The id of the life event type, as list-life-event-types gives it.
-
groupsarrayoptional - Groups of fields, each drawn under its name. Each group: placement_id (the id get-life-event-type-fields gives, to keep an existing group), name, and fields. Each field: key (the key get-life-event-type-fields gives, to keep an existing field; leave it out for a new one), label, type (one of: text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration, relation, file, image, avatar, address, repeater, divider, heading, help), is_required, help_text, settings (an object of strings; max_length, min, max, decimals, max_choices, repeat_min and repeat_max are whole numbers) and choices (a list of strings).
-
fieldsarrayoptional - Fields nobody grouped, shown first. Each field: key (the key get-life-event-type-fields gives, to keep an existing field; leave it out for a new one), label, type (one of: text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration, relation, file, image, avatar, address, repeater, divider, heading, help), is_required, help_text, settings (an object of strings; max_length, min, max, decimals, max_choices, repeat_min and repeat_max are whole numbers) and choices (a list of strings).
Delete a kind of life event the account created. One that came with the account, or that life events were recorded with, is refused; stop offering it instead. The change is written to the account log.
-
life_event_typestringrequired - The id of the life event type, as list-life-event-types gives it.
Create a category to file kinds of life event under, such as Sport. It is added at the end of the list. The change is written to the account log.
-
namestringrequired - The name of the category, such as Sport.
Rename a category of life event types. The change is written to the account log.
-
life_event_categorystringrequired - The id of the category, as list-life-event-categories gives it.
-
namestringoptional - The new name.
Offer a category of life event types when somebody records a life event, or stop offering it. Life events already recorded stay. The change is written to the account log.
-
life_event_categorystringrequired - The id of the category, as list-life-event-categories gives it.
-
is_activebooleanrequired - True to offer it, false to stop offering it.
Move a category of life event types to another place in the list. The change is written to the account log.
-
life_event_categorystringrequired - The id of the category, as list-life-event-categories gives it.
-
positionintegerrequired - Where it goes in the list of categories, counting from 1.
Delete a category the account created. One that came with the account, or that still holds types, is refused; move its types to another category first. The change is written to the account log.
-
life_event_categorystringrequired - The id of the category, as list-life-event-categories gives it.