Configure a field
Change what a field is called and how it behaves.
As with adding one, changing a field of a section that has been published opens a draft of the section and changes it there, leaving the published section and every other template placing it alone.
The type, whether the field repeats, and what a relation points at are settled when the field is added and are not sent here. Everything else may be sent: a setting left out keeps its value, and a setting sent as null goes back to its default. The label and the five switches cannot be null.
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.
The number of the version within its template, counting from 1, which is the number shown in the version history and the number a change note refers to. It is not a row id, so version 1 of one template and version 1 of another are different things reached through different templates.
The id of the placement, which is not the id of the section. It is the id a placement comes back with when a version is read.
The id of the field. It changes the first time a published section is changed, because the change opens a draft of the section and the fields are copied into it. The key does not change, and the answer carries the new id.
What the field is called on the form. It cannot be null.
A sentence shown under the field, or null to remove it.
What the empty box shows as an example, or null to remove it.
Whether the record refuses to save without it.
Whether the value is hidden until somebody asks to see it.
Whether the value is repeated at the top of the record.
Whether two records may hold the same value.
Whether two records sharing this value are likely the same record, so the pair is proposed as a duplicate.
The list a field offering choices takes them from, as the id the value lists endpoint gives. A list of another account is refused. Null removes it.
What the field starts filled with.
Settings belonging to this kind of field alone. A file or image field takes accepted_mime_types, a list of at most 20 mime types such as image/png, and an image field takes image types only. Anything else answers 422 on options.
Extra rules a value has to satisfy.
The fewest repetitions allowed.
The most repetitions allowed.
How several values are ordered: newest_last or newest_first.
Returns
The field as it now stands, carrying the id it holds in the section version that took the change.
The field.
Always field. 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 field is named in an import or an export, settled when the field is added.
What kind of thing the field holds: one of text, textarea, number, boolean, url, email, phone, select, multiselect, radio, date, recurring_date, duration (a whole number of minutes), relation, file, image, avatar, address, repeater, divider, heading or help. The last three carry no value and are there to lay the form out.
What the field is called on the form.
A sentence shown under the field, or null when there is none.
What the empty box shows as an example, or null.
Where the field sits in its section, counting from 1.
Whether the record refuses to save without it.
Whether the value is hidden until somebody asks to see it.
Whether the value is repeated at the top of the record.
Whether two records of this template may hold the same value.
Whether two records sharing this value are likely the same record, so the pair is proposed as a duplicate. Not the same as unique: a household can legitimately share one telephone number, and proposing a pair is right where refusing the value would be wrong.
Whether the field holds several values rather than one. It follows from the type and is settled when the field is added.
The fewest repetitions allowed, or null when there is no floor.
The most repetitions allowed, or null when there is no ceiling.
How several values are ordered against each other, or null when the field holds one.
Settings belonging to this kind of field alone, or null. What it holds depends on the type.
Extra rules a value has to satisfy, or null.
What the field starts filled with, or null.
What a relation field points at, or null when the field is not a relation. It is settled when the field is added.
When the field was added, as a count of seconds since 1970.
When it last changed, as a count of seconds, or null.
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.