Update an entity type
Change what a kind of object is called, what it is for, and how it is drawn.
Send only what changes. The names, the icon and the colour cannot be null and are refused with 422 when sent as null. A description sent as null is cleared.
The slug is left alone. A rename is a change of wording rather than a change of thing: Animal becoming Pet is the same type, and every link that already went out keeps working. Where the type sits in your navigation, whether records may still be filed under it, and everything already filed under it are each untouched here.
Parameters
Sent as JSON. Anything not listed here is ignored.
The id of the type. A path that is not a uuid answers 404 without a query being run, so neither a sequential number nor the slug reaches anything here.
What one of these is called. Up to 255 characters.
What several of them are called. Up to 255 characters.
What the type is for, up to 65535 characters. Null says it has none.
One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check.
Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case.
Returns
The entity type object as it now reads. A type belonging to somebody else answers 404 and is left as it was.
The type.
Always entity_type. 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.
How the type is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the type is declared and never rebuilt, so a link that already went out keeps working through any rename. Use it to build a browser link; use the id for every call here.
What one of these is called: Animal, Company, Recipe. Up to 255 characters. Reduced to plain text when it was written down, so no markup survives here.
What several of them are called. Stored rather than derived from the singular, because a plural derived in English is wrong in most other languages.
What the type is for, up to 65535 characters, or null when nobody said.
One of profile, logs, security, preferences, key, device, info, life event, mail, sun, moon or check. It is a name rather than a drawing, so the picture lives in the application and the type stores a word.
Exactly one of #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #5d5f96 or #1d1d20, written in lower case. It is how types are told apart at a glance in the navigation, and it is decoration: nothing depends on it.
Where the type sits in the vault navigation, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in. Types that may no longer be filed under are numbered along with the rest, so one switched back on finds the place it had.
Whether new records may still be filed under the type. False stops the button that adds another and touches nothing already filed: every record stays readable and stays editable.
How many records of this kind exist, across every vault of your account. It is a running count kept as records are written down and deleted, rather than something counted when you ask, and it is what decides whether the type may be deleted.
When the type was declared, 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.