Offer or stop offering a template
Say whether a template may still be applied to a record.
Send the state you want rather than asking for a toggle, so sending the same state twice confirms it instead of inverting it, and a retried request cannot leave a template in the state you did not ask for.
Stopping a template touches nothing already using it. Every record on it stays readable and stays editable, and the template keeps the place it had, so one switched back on returns where it was rather than to the end.
Parameters
Sent as JSON. Anything not listed here is ignored.
The id of the template. A path that is not a uuid answers 404 without a query being run, so neither the slug nor a sequential number reaches anything here.
True to offer the template, false to stop offering it.
Returns
The template as it now stands. A template belonging to somebody else answers 404.
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.