Person management
Journal management
API documentation
Account management
Persons
Journal
Life Events
Table of contents
This endpoint lets you manage life events for contacts in your account.
Life events help you track important moments in a person's life, such as birthdays, anniversaries, or other significant occasions.
Each life event can be customized with an icon, colors, and reminder settings.
The Life Event object
This object represents a life event attached to a person in your account.
Attributes
The ID of the life event.
The object type. Always 'life_event'.
The description of the life event.
The date when the life event occurred, in ISO 8601 format.
Additional comments about the life event.
The icon associated with the life event.
The background color for the life event.
The text color for the life event.
Whether the life event should trigger reminders.
The ID of the person this life event is attached to.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"id":
123
,
"object":
"life_event"
,
"description":
"Birthday"
,
"happened_at":
"2024-03-15"
,
"comment":
"Celebrated with family"
,
"icon":
"cake"
,
"bg_color":
"#FF5733"
,
"text_color":
"#FFFFFF"
,
"should_be_reminded":
true
,
"person_id":
456
,
"created_at":
1710424800
,
"updated_at":
1710424800
}
Get the list of life events for a person
This endpoint retrieves all life events associated with a specific person, ordered by creation date in descending order.
URL parameters
The ID of the person whose life events you want to retrieve.
Query parameters
No query parameters are available for this endpoint.
Response attributes
An array of life event objects.
{
"data": [
{
"id":
123
,
"object":
"life_event"
,
"description":
"Birthday"
,
"happened_at":
"2024-03-15"
,
"comment":
"Celebrated with family"
,
"icon":
"cake"
,
"bg_color":
"#FF5733"
,
"text_color":
"#FFFFFF"
,
"should_be_reminded":
true
,
"person_id":
456
,
"created_at":
1710424800
,
"updated_at":
1710424800
}
]
}
Get a specific life event
This endpoint retrieves a specific life event by its ID.
URL parameters
The ID of the person the life event belongs to.
The ID of the life event to retrieve.
Query parameters
No query parameters are available for this endpoint.
Response attributes
The requested life event object.
{
"data": {
"id":
123
,
"object":
"life_event"
,
"description":
"Birthday"
,
"happened_at":
"2024-03-15"
,
"comment":
"Celebrated with family"
,
"icon":
"cake"
,
"bg_color":
"#FF5733"
,
"text_color":
"#FFFFFF"
,
"should_be_reminded":
true
,
"person_id":
456
,
"created_at":
1710424800
,
"updated_at":
1710424800
}
}
Create a new life event
This endpoint creates a new life event for a person. It will return the life event in the response.
URL parameters
The ID of the person to add the life event to.
Query parameters
The description of the life event.
The date when the life event occurred, in ISO 8601 format.
Additional comments about the life event.
The icon associated with the life event.
The background color for the life event.
The text color for the life event.
Whether the life event should trigger reminders. Defaults to false.
Response attributes
The created life event object.
{
"data": {
"id":
123
,
"object":
"life_event"
,
"description":
"Birthday"
,
"happened_at":
"2024-03-15"
,
"comment":
"Celebrated with family"
,
"icon":
"cake"
,
"bg_color":
"#FF5733"
,
"text_color":
"#FFFFFF"
,
"should_be_reminded":
true
,
"person_id":
456
,
"created_at":
1710424800
,
"updated_at":
1710424800
}
}
Update a life event
This endpoint updates an existing life event. It will return the updated life event in the response.
URL parameters
The ID of the person the life event belongs to.
The ID of the life event to update.
Query parameters
The description of the life event.
The date when the life event occurred, in ISO 8601 format.
Additional comments about the life event.
The icon associated with the life event.
The background color for the life event.
The text color for the life event.
Whether the life event should trigger reminders.
Response attributes
The updated life event object.
{
"data": {
"id":
123
,
"object":
"life_event"
,
"description":
"Birthday"
,
"happened_at":
"2024-03-15"
,
"comment":
"Celebrated with family"
,
"icon":
"cake"
,
"bg_color":
"#FF5733"
,
"text_color":
"#FFFFFF"
,
"should_be_reminded":
true
,
"person_id":
456
,
"created_at":
1710424800
,
"updated_at":
1710424800
}
}
Delete a life event
This endpoint deletes a life event. It will return a 204 No Content response on success.
URL parameters
The ID of the person the life event belongs to.
The ID of the life event to delete.
Query parameters
No query parameters are available for this endpoint.
Response attributes
This endpoint returns a 204 No Content response with no body on success.
204 No Content
Please login to vote.
It's free and will help us improve the page.
Taylor will be proud of you.
Last updated on April 11, 2025.