Browse the tools
Life events
A life event is something that happened on a date, often with other people, such as a wedding, a move or a new job. Life events form the timeline of a contact.
Tools
List the life events of one vault, the most recent first, a page at a time, optionally only those one contact took part in. The values of sensitive fields are given only to a key holding the sensitive fields scope.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
contactstringoptional - The id of a contact, as list-contacts gives it. Only the life events this contact took part in are listed.
-
pageintegeroptional - The page to read, starting at 1.
-
per_pageintegeroptional - How many life events a page holds: 25 unless asked, 100 at most.
Look one life event up in a vault: its type, its date, what was written about it, who was there and the values of its custom fields, with the field ids update-life-event takes. The values of sensitive fields are given only to a key holding the sensitive fields scope.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
life_eventstringrequired - The id of the life event, as list-life-events gives it.
Write down something that happened, on a date, with the people who were there. It goes on the timeline of every one of them, the first being the person it is recorded for. Read the custom fields of the type with get-life-event-type-fields first: values are keyed by field id. A file field cannot be written. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
life_event_typestringrequired - The id of its type, as list-life-event-types gives it. A type switched off cannot be chosen.
-
happened_onstringrequired - The day it happened, as YYYY-MM-DD.
-
participantsarrayrequired - The ids of the contacts who were there, in order, as list-contacts gives them. The first is the person it is recorded for.
-
titlestringoptional - A title. Without one it is called by the name of its type.
-
narrativestringoptional - What happened.
-
locationstringoptional - Where it happened.
-
duration_in_minutesintegeroptional - How long it lasted, in minutes.
-
fieldsobjectoptional - The values of the custom fields, keyed by the field id get-life-event-type-fields gives. A select field takes the id of its choice.
Change a life event. The fields given replace its custom values, except sensitive fields, which keep their value unless given. The first participant has to stay the person it is recorded for. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
life_eventstringrequired - The id of the life event, as list-life-events gives it.
-
life_event_typestringoptional - The id of another type, as list-life-event-types gives it. Choosing one moves the life event to the custom fields of that type and lets the old values go.
-
happened_onstringoptional - The day it happened, as YYYY-MM-DD.
-
participantsarrayoptional - The ids of the contacts who were there, in order, as list-contacts gives them. The list replaces the one recorded. The first has to stay the person it is recorded for.
-
titlestringoptional - A title.
-
narrativestringoptional - What happened.
-
locationstringoptional - Where it happened.
-
duration_in_minutesintegeroptional - How long it lasted, in minutes.
-
fieldsobjectoptional - Custom field values, keyed by the field id get-life-event gives. A repeating group takes a list of repetitions, each as {id, values}: the id is the row get-life-event gives, and the values are keyed by the ids of the fields inside the group.
Take a life event off the timeline of everybody who was there. restore-life-event puts it back. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
life_eventstringrequired - The id of the life event, as list-life-events gives it.
Put a deleted life event back on the timeline of everybody who was there. The change is written to the account log.
-
vaultstringrequired - The id of the vault, as list-vaults gives it.
-
life_eventstringrequired - The id of the deleted life event, as list-life-events gave it.