Offer or retire a life event category
Say whether a category, and every nature under it, may still be chosen when a life event is recorded.
Retiring a category takes it out of the choice offered when somebody records a life event. It is the answer wherever deletion is refused, and it works on a category the product supplied as readily as on your own.
Nothing already written is touched. Every life event keeps its nature and reads as it did, and the category keeps the place it had, so offering it again puts it back where it was rather than at the end.
Retiring a category retires the choice of every nature under it, and offering it again brings them all back, each still holding whether it is offered in its own right.
Send the state you want rather than asking for a toggle, so sending the same value twice confirms it instead of inverting it.
Parameters
Sent as JSON. Anything not listed here is ignored.
The id of the category. A path that is not a uuid answers 404 without a query being run.
True to offer the category again, false to retire it.
Returns
The life event category object in the state you asked for.
The category.
Always life_event_category. 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 category is called. A category 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.
Where the category sits in the settings, the pickers and the journal filters, counting from 1. Retired categories are numbered along with the rest, so one switched back on finds the place it had.
Whether the product supplied the category with the account. It governs one thing and one thing only: a supplied category cannot be deleted. It may be renamed, moved and retired like any other.
Whether the category and the natures under it are offered when a life event is recorded. False removes the whole category from that choice and touches nothing already written.
How many life event natures are filed under the category, retired ones counted. It is what decides whether the category may be deleted.
When the category was added, as a count of seconds since 1970 rather than a written date.
When it last changed, as a count of seconds. Equal to created_at until it first changes.
Where to find this record.
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.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.