Manage regions from the REST API
Three new v1 endpoints let you create, list, and read a site’s regions, including their element trees, from the REST API.
List Regions
Returns a site’s regions for one locale, with cursor-based pagination through limit (1–100, default 20) and startingAfter.
Create Region
Creates a region in one locale. siteId, id, name, and elements are required. The component type at the root of elements becomes the region’s type. Returns 409 if the region already exists.
Get Region
Returns a single region in one locale. URL-encode the id if it contains reserved characters such as /.
- You choose the ID: Makeswift doesn’t generate region IDs. You assign the ID (for example,
site-header), and it must be unique within a site and locale. - One locale per request: all three endpoints accept a
localeparameter, as either a locale code likeen-USor a site locale UUID. If you leave it out, the request uses the site’s default locale. A region has to exist in the default locale before you can create it in another locale. - Element trees are optional: pass
include=elementsto List Regions or Get Region to get each region’s element tree. Without it,elementsisnull.
The region endpoints are in beta and may change. Requests return 403 until the feature is enabled for your site or workspace. To opt in, contact support: support@makeswift.com.
For details, see List Regions, Create Region, and Get Region.
Manage site typographies from the REST API
Four new v4 endpoints let you create, read, and update a site’s typographies (the text styles in the Visual Builder) from the REST API.
List Typographies
Returns a site’s typographies in position order, with cursor-based pagination through limit (1–100, default 20) and startingAfter.
Create Typography
Adds a typography to a site. siteId is required; name and style are optional.
Get Typography
Returns a single typography.
Update Typography
Changes a typography’s name or style. Omitted fields keep their current values. When you send style, it replaces the full per-device array, so entries for individual devices aren’t merged. A / in the name nests the typography in a group, so renaming H1 to Headings / H1 moves it into the Headings group.
- Per-device styles:
styleis an array of{ deviceId, value }entries. Eachvaluecan setfontFamily,fontSize({ value, unit }),fontWeight,lineHeight,letterSpacing,textAlign,italic,underline,strikethrough,uppercase, andcolor. - Colors come from swatches:
color.swatchIdtakes theidof an existing swatch, so create the swatch first with the Swatch API.color.alpha(0–1) sets opacity. - Two IDs: the typography endpoints use
id.referenceIdis the value a Text element’stypographyprop uses in a page’s element tree, so use it to find a typography in page content.
The typography endpoints are in beta and may change. Requests return 403 until the feature is enabled for your site or workspace. To opt in, contact support: support@makeswift.com.
For details, see List Typographies, Create Typography, Get Typography, and Update Typography.