Create a record
Write down a record of one kind in one vault, with what its template asks.
The record is written on the published version of the template the vault uses for this kind, or on the one you name in structure_version_id. Everything is written together or nothing is: a value refused in any section leaves no record behind.
A field you leave out starts with the default its template gives it, as it would on a new contact. Send it empty to leave it empty.
A type the vault does not show answers 404. A type the vault still shows because it holds records of it answers 422 with the reason on name when the type was turned off, when the vault has no published template for it and you name none, or when that template requires something that cannot be filled in here.
A relation field takes the id of the record it names: a contact, or a record of the kind the field points at. It has to be in the same vault, and anything else answers 422 on that field.
Parameters
Sent as JSON. Anything not listed here is ignored.
The vault the records live in, named either by the readable name it reports as slug or by its id. Both answer.
The kind of record. A type the vault does not use, which is one with no published template set for it there and no record in it, answers 404.
What the record is called, up to 255 characters.
The published version of one of your active templates for this kind, which says what the record holds. Left out, the record starts from the template the vault uses for this kind. A version of another kind, of a template turned off or belonging to somebody else answers 422 on this field, and so does a version that is no longer the one its template publishes.
The values, keyed by the id of the field they fill in, each checked against what its field accepts. A field left out writes nothing. Files are sent as multipart under fields[id].
The label picked beside a value, keyed by field id, for a field that carries one.
The wording typed when the picked label is the open one, keyed by field id.
True for a recurring date whose year nobody knows, keyed by field id.
True for a recurring date whose month nobody knows, keyed by field id.
Returns
The entity object that was written down. A vault or a type belonging to somebody else answers 404.
The record.
Always entity. 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 record is called, up to 255 characters. It is how the record is listed and sorted, and it is reduced to plain text when it is written down.
The kind of record it is. It never changes.
The first letter of the first two words of the name, drawn on the generated avatar.
The background the generated avatar is drawn on. It is picked when the record is written down and kept afterwards.
The picture standing in for the record, with its id and url, or null when it is drawn as its initials.
Whether the record was put away. An archived record is still listed.
The exact version of the template the record was written on. A record stays on that version until somebody moves it.
The name of the template that version belongs to.
The values the record holds, in no particular order. A field left empty is not listed.
One value.
The id of the field, which is the key a value is written under when the record is updated.
How the field is named in an import or an export. It is unique inside its section only.
What the field is called on the record.
The kind of field: text, date, select, address and so on.
For a field inside a repeating group, the id of the repetition it belongs to, which is the id an update keeps that repetition by. Null otherwise.
The value, written as the page of the record shows it. A file field gives the name of the file. Null when hidden.
Whether the value was held back because the field is sensitive and the key does not hold the sensitive-fields scope.
When the record was written down, as a count of seconds since 1970.
When it last changed, as a count of seconds, or null.
Where to find this record.
The absolute address this record is read from.
The page of the record in the application, 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.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.