Change a life event
Change what a life event says: its type, its date, its text and who was there.
An attribute left out keeps its value. The title, the narrative, the location and the duration are cleared by null, and the type, the date and the participants cannot be null. Leave fields out and every custom field value stays as it is. Send fields and it replaces the whole set, so a field missing from it is cleared, and a repetition sent without its id replaces the one it stood for. A sensitive field the key cannot see keeps its value unless it is sent.
The first participant has to stay the person the life event is recorded for, and anything else answers 422. To record it for somebody else, delete it and record it again.
A life event keeps the version of its type's fields it was written with while its type stays the same. Choosing another type moves it to that type's fields and lets the old values go.
Parameters
Sent as JSON. Anything not listed here is ignored.
The vault the life events live in, named either by the readable name it reports as slug or by its id.
The id of the life event. One addressed through the wrong vault, or belonging to another account, answers 404.
The id of its type, as the life event types endpoints give it. A type switched off cannot be chosen for a new life event and answers 422.
The day it happened, written as a year, a month and a day.
The contacts who were there, in order, each named by its slug or its id. The first is the person the life event is recorded for. A contact of another vault answers 404.
A title, up to 255 characters. Without one, the life event is called by the name of its type.
What happened, up to 65,535 characters.
Where it happened, up to 255 characters.
How long it lasted, from 1 to 100,000 minutes.
The values of the custom fields its type asks for, keyed by field id. A text field takes a string, a select field the id of its choice, a multiple select field a list of them, a date a year, a month and a day. A repeating group takes a list of repetitions, each holding its id when it already exists and its values keyed by the ids of the fields inside the group. A file field cannot be written here and answers 422.
Returns
The life event object as it stands now.
The life event.
Always life_event. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.
Everything the record holds.
What the life event is called: its title, or the name of its type when it has none.
The title written for it, or null.
Its type. A type deleted since still names the life events recorded as it.
The id of the type, as the life event types endpoints give it.
What the type is called.
The group it was recorded on, as an object holding its id and its name, or null when it was not recorded on a group or the group has been deleted.
The day it happened, written as a year, a month and a day.
How long it lasted, in minutes, or null.
What was written about it, or null.
Where it happened, or null.
The contacts who were there, in order. The first is the person the life event is recorded for.
One contact who was there.
The id of the contact.
The name the contact is shown under.
Where the contact stands in the list, counting from 0.
The values of the custom fields its type asks for. A field left empty is not listed.
One value.
The id of the field, which is the key a value is written under when the life event is updated.
How the field is named in an import or an export. It is unique inside its group only.
What the field is called on the life event.
The kind of field: text, date, select, address and so on.
For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise.
The value, written as the contact page shows it. A file field gives the name of the file. Null when hidden.
Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope.
Where it was written from: contact, dashboard, group, api, mcp, day, import or module.
When it was deleted, as a count of seconds since 1970, or null.
When it was written down, as a count of seconds since 1970.
When it last changed, as a count of seconds since 1970.
Where to find this record.
The absolute address this record is read from.
The page of the contact the life event is recorded for, whose timeline shows it, in the application. It is the link to give a person.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.