Portal Design API

Portal Design is the look of a project's portal page, the storefront every project has at its own address: the colours, the type, the shape of the cards and buttons, the layout, every line of wording, the blocks under the plans, the announcement bar, the media, the order and visibility of the parts, the behaviour around the plans, what search engines and shared links see, the creator's own measurement tags and stylesheet, and the language. The dashboard page is Portal Designer, the last entry of a project's menu, and the platform bot offers the same settings.

A design lives as two documents: the published one members see and a draft being edited. Every write lands in the draft; publish makes it the published design and discard throws it away; a preview_url on every read shows the draft for ten minutes, and is null until the project has a handle, because there is no portal page to preview. These routes take the project in the path and need project:view for the read and project:update for the writes, the same gate as the project's own settings; a design the portal could not draw is refused as VALIDATION_FAILED naming the key.

A preset recolours. Sending preset alone sets the six colours from the preset; send a colour beside it to keep that one. A body text, heading or caption colour that blends into the surface or the background (under a 3:1 contrast ratio) is refused, whichever of the two you sent.

EndpointsCopy Anchor Link

Related

Portal DesignerEvery section, what it changes and how the bot edits it.project.* eventsThe event a publish raises.Ability Catalogproject:view and project:update.