API v1
v1
View as Markdown

Add a life event type

POST /api/v1/life-event-types

Add a nature of your own, when the ones the product supplies do not describe what you actually do.

The nature goes at the end of the category you file it under and is offered straight away. Retire it afterwards if you are preparing a vocabulary you do not want offered yet.

It starts with no custom fields, which is a perfectly ordinary state: a life event of a brand new nature can be recorded immediately, carrying nothing beyond what every life event carries. Give it fields at their own address when you want them.

Body parameters

Sent as JSON. Anything not listed here is ignored.

life_event_category_id uuid Required

The category to file the nature under. A category belonging to somebody else answers 404.

name string Required

What the nature is called. Up to 255 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused.

description string Optional

A sentence saying what the nature covers. Up to 255 characters, stripped the same way.

icon string Optional

The glyph drawn beside the nature, from the catalogue the product ships. Anything else is refused.

colour string Optional

The tint the nature is drawn in, from the palette the product ships. Anything else is refused.

updates_last_in_touch boolean Optional

Whether its life events set the Last in touch date of the contacts they are recorded with. Left out, it does.

Returns

The life event type object that was added.

data object

The nature.

data.type string

Always life_event_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.

data.id string

The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.

data.attributes object

Everything the record holds.

data.attributes.life_event_category_id uuid

The category the nature is filed under. Moving a nature to another category is an ordinary change, and the life events recorded with it are regrouped along with it.

data.attributes.name string

What the nature is called. One the product supplied reads in the language you ask for, until somebody renames it, after which their words stand in every language. Up to 255 characters, reduced to plain text, so no markup survives here.

data.attributes.description string

A sentence saying what the nature covers, shown where somebody chooses one. Up to 255 characters, or null when nobody wrote one.

data.attributes.icon string

The glyph drawn beside the nature, chosen from the catalogue the product ships, or null to read by name alone.

data.attributes.colour string

The tint the nature is drawn in, chosen from the palette the product ships, or null to take the ordinary one.

data.attributes.position integer

Where the nature sits inside its category, counting from 1. Retired natures are numbered along with the rest, so one switched back on finds the place it had.

data.attributes.is_system boolean

Whether the product supplied the nature with the account. It governs one thing and one thing only: a supplied nature cannot be deleted. It may be renamed, redrawn, moved and retired like any other.

data.attributes.is_active boolean

Whether the nature is offered when a life event is recorded. False takes it out of that choice and touches nothing already written.

data.attributes.updates_last_in_touch boolean

Whether a life event of this nature sets last_interaction_at, the Last in touch date, on the contacts it is recorded with. True for a moment shared with them, such as a call or a meal, and false for news about one of them, such as a move.

data.attributes.created_at timestamp

When the nature was added, as a count of seconds since 1970 rather than a written date.

data.attributes.updated_at timestamp

When it last changed, as a count of seconds. Equal to created_at until it first changes.

data.links object

Where to find this record.

data.links.self string

The absolute address this record is read from.

Rate limit

Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.

POST
curl https://my.monicahq.com/api/v1/life-event-types \
-X POST \
-H "Authorization: Bearer $MONICA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
"name": "Board game night",
"description": "An evening around a table with a box of cardboard.",
"icon": "activity",
"colour": "bg-sky-500",
"updates_last_in_touch": "true"
}'
const response = await fetch('https://my.monicahq.com/api/v1/life-event-types', {
method: 'POST',
headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
body: JSON.stringify({
life_event_category_id: '5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95',
name: 'Board game night',
description: 'An evening around a table with a box of cardboard.',
icon: 'activity',
colour: 'bg-sky-500',
updates_last_in_touch: 'true',
}),
})
const data = await response.json()
$response = Http::withToken($token)->post('https://my.monicahq.com/api/v1/life-event-types', [
'life_event_category_id' => '5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95',
'name' => 'Board game night',
'description' => 'An evening around a table with a box of cardboard.',
'icon' => 'activity',
'colour' => 'bg-sky-500',
'updates_last_in_touch' => 'true',
]);
Response 201
{
"data": {
"type": "life_event_type",
"id": "8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18",
"attributes": {
"life_event_category_id": "5f8b3c21-9d07-4a64-8e12-7b0a4d6c3e95",
"name": "Board game night",
"description": "An evening around a table with a box of cardboard.",
"icon": "activity",
"colour": "bg-sky-500",
"position": 2,
"is_system": false,
"is_active": true,
"updates_last_in_touch": true,
"created_at": 1756339200,
"updated_at": 1756425600
},
"links": {
"self": "https://my.monicahq.com/api/v1/life-event-types/8b2e5c70-1a94-4f38-b6d2-0e7c94a35f18"
}
}
}

Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.