API v1
v1
View as Markdown

Add a possession condition

POST /api/v1/possession-conditions

Add a state the possessions of your account can be in. It goes last in the order.

The change is written to the account log.

Body parameters

Sent as JSON. Anything not listed here is ignored.

name string Required

What the condition reads. Up to 50 characters. Markup and surrounding blank space are stripped, and a name left with nothing in it is refused. A name another condition of the account already has, ignoring case, is refused with “You already have a condition with this name.”

colour string Optional

One of the vault colours: #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a or #4a4a52. Blue when left out.

icon string Optional

One of the glyphs of the catalogue: 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. None when left out.

Returns

The possession condition object that was added.

data object

The possession condition.

data.type string

Always possession_condition. 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.name string

What the condition reads, such as New or Broken.

data.attributes.colour string

One of the eight vault colours, as a hexadecimal value.

data.attributes.icon string

One of the glyphs of the catalogue, or null when the condition has none.

data.attributes.position integer

Its place in the order the account keeps, from best to worst, counting from 1.

data.attributes.created_at timestamp

When the condition was added, as a count of seconds since 1970.

data.attributes.updated_at timestamp

When it last changed, as a count of seconds, or null.

data.links object

Where to find this record.

data.links.self string

The absolute address this record is read from.

data.links.web string

The settings screen where the conditions of the account are managed, which opens for somebody signed in rather than for a key. 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.

POST
curl https://my.monicahq.com/api/v1/possession-conditions \
-X POST \
-H "Authorization: Bearer $MONICA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Mint",
"colour": "#2f7f86",
"icon": "star"
}'
const response = await fetch('https://my.monicahq.com/api/v1/possession-conditions', {
method: 'POST',
headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
body: JSON.stringify({
name: 'Mint',
colour: '#2f7f86',
icon: 'star',
}),
})
const data = await response.json()
$response = Http::withToken($token)->post('https://my.monicahq.com/api/v1/possession-conditions', [
'name' => 'Mint',
'colour' => '#2f7f86',
'icon' => 'star',
]);
Response 201
{
"data": {
"type": "possession_condition",
"id": "4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
"attributes": {
"name": "Mint",
"colour": "#2f7f86",
"icon": "star",
"position": 7,
"created_at": 1761436800,
"updated_at": 1761436800
},
"links": {
"self": "https://my.monicahq.com/api/v1/possession-conditions/4c1e7a92-8d35-4f06-b2a9-e3f71c5d8b40",
"web": "https://my.monicahq.com/settings/account/possession-conditions"
}
}
}

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