Create a template
Define a new kind of record: what a contact page shows, or everything the account keeps about one kind of thing.
The template starts empty and goes at the end of your list. It is created with a draft version numbered 1 holding a single page and nothing on it, so there is somewhere to build before anything is published. Until you publish, the template has no published version and cannot be applied to a record.
The slug is settled here and never rebuilt afterwards, so a link that already went out keeps working through any rename. It is made from the name.
A template describing an entity has to name the type it describes, and that type has to be one of yours. A template describing a contact names none.
Body parameters
Sent as JSON. Anything not listed here is ignored.
What the template is called. Up to 255 characters. Markup and surrounding blank space are stripped.
Either contact or entity.
What the template is for. Up to 65535 characters. Absent, empty or null all mean it has none.
The entity type this template describes. Required when applies_to is entity, refused as invalid when the type belongs to somebody else, and ignored when applies_to is contact.
Returns
The template that was created, with its settled slug and no published version.
The template.
Always template. 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 template is addressed in the application itself, in lower case letters, numbers and dashes. It is settled when the template is created 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 the template is called. A template the product supplied answers with the name translated into your language rather than the one stored, so the same template reads differently to two people.
What the template is for, or null when nobody said.
Either contact or entity. A template describing a contact applies to the people in every vault; one describing an entity applies only to records of the type named in entity_type_id.
The id of the entity type this template describes, or null when it describes contacts. Read that type through the entity types endpoints.
Whether the product supplied the template rather than you. It says where the template came from and locks nothing: a supplied template is renamed, moved, stopped and deleted exactly like one you made. Duplicating it first is usually the better move, because a copy leaves the original for anything already using it.
Whether the template may still be applied to a record. False stops it being offered and touches nothing already using it: every record on it stays readable and stays editable.
Where the template sits in the list on the templates screen, counting from 1. It is the order you arranged, and it is the order the list endpoint answers in.
The number of the version records are put on when the template is applied today, or null when nothing has been published yet. A template with no published version is one still being designed.
When the template was created, 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.