Renamed fields and paths
Typograph names everything on the wire by one convention: a stated boolean starts with is_, has_
or can_, a timestamp ends in _at, a count is <noun>_count, a reference into the template
document ends in _uuid, and names are written in full. Moving to it renamed the names below in
one release, without a transition: the API sends and accepts only the new name, so an integration
that reads or sends an old one must switch.
Two places still read the old name, as a deprecated alias, because stored data and customers' packages carry it:
- Publisher requests:
spreads_as_single_pages(nowsingle_pages) andmerge.file_name(nowmerge.filename). When both are sent, the new name wins. - Template JSON and template packages: every old key, and a package's
templatebundle.json(nowtemplate_bundle.json). The template keys are listed under Older key names.
Paths
| Old | New |
|---|---|
/v1/file/{resourceType}/{resourceId}/invites[/{id}] | /v1/file/{resourceType}/{resourceId}/invitations[/{id}] |
/v1/file/users/me/invites | /v1/file/users/me/invitations |
/v1/file/templates/{id}/collab-token | /v1/file/templates/{id}/collaboration-token |
/v1/file/recent/searched | /v1/file/recent/searches |
File service
| Old | New | Where |
|---|---|---|
resolved, ?resolved= | is_resolved, ?is_resolved= | comment, resolve a comment |
expired | is_expired | every presigned URL |
featured, ?featured= | is_featured, ?is_featured= | pre-made templates |
usable | is_usable | pre-made templates |
exists | is_found | font lookup |
saved | is_saved | touch a template |
complete | is_complete | form values |
from, params | sender, parameters | notification |
targets[].uuid | targets[].element_uuid | template fields |
element_id | element_uuid | form fields |
label_name | label | update a font |
dev_url | development_url | template |
thumbnail | thumbnail_filename | shared item |
total_templates, total_users | template_count, user_count | project, team, shared item |
?trash= | ?include_deleted= | search |
propertyPath | property_path | a 422's violations (also the converter and the publisher) |
Identity service and the API home
| Old | New | Where |
|---|---|---|
expired | is_expired | organization invitation |
deletion_scheduled_for | deletion_scheduled_at | organization |
my_can_use_quota, my_role | can_use_quota, role | organization |
website | website_url | organization, create and update |
auth, portal, website | authentication, portal_url, website_url | GET / |
Publisher, subscription and webhooks
| Old | New | Where |
|---|---|---|
valid, plan.proof | is_valid, plan.is_proof | merge check |
rows_total, rows_unchecked | row_count, unchecked_row_count | merge check |
rows_total, rows_done, rows_failed | row_count, printed_row_count, failed_row_count | merge job and its publication.* events |
current_period_start, current_period_end | current_period_starts_at, current_period_ends_at | subscription |
period_start, period_end | period_starts_at, period_ends_at | usage |
attempts | attempt_count | webhook delivery |
MCP server
| Old | New |
|---|---|
tools invite_create, invite_list_my, invite_list_resource, invite_accept, invite_decline, invite_delete | invitation_create, invitation_list_my, invitation_list_resource, invitation_accept, invitation_decline, invitation_delete |
argument invite_id | invitation_id |
arguments featured, website, font_update.name | is_featured, website_url, label |
results deleted, restored, touched, accepted, declined, revoked, removed, marked_read, marked_unread, marked_all_read, code_sent | gone: success says it |
results download_available, valid, proof | is_download_available, is_valid, is_proof |
results deletion_scheduled_for, website, earliest_expiry | deletion_scheduled_at, website_url, earliest_expires_at |
Every other result follows the API's names, booleans included (is_active, is_featured, is_expired).
Webshop API
| Old | New |
|---|---|
default (language) | is_default |
works_in_the_back_office | is_staff |
enabled (feedback) | is_enabled |
personalizable | is_personalizable |
chosen (facet value) | is_selected |
downloadable (print file) | is_downloadable |
print_spec | print_specification |
?q= | ?query= |
favourites, /users/me/favourites/{slug}, too_many_favourites | favorites, /users/me/favorites/{slug}, too_many_favorites |
order files' element_id | element_uuid |