# Create a website page **POST /newsletters/{newsletter}/website-pages** Writes a page of this newsletter's website. Needs `content: write`, and is a write. A page is free-form HTML, CSS and JavaScript that you own outright. There is no template, no enforced layout and no deploy step: an edit to a published page is live the moment it commits. `kind` decides what `path` means and cannot be changed afterwards. * `page` is a fixed path. Anything you like: `/about`, `/subscribe`. * `newsletter` is the article list, and its path is where a reader clicking the newsletter's name or avatar inside Commune arrives. A newsletter may have one. * `article` is a URL **pattern** that renders every article. It has to contain `:article`, and may also use `:year`, `:month`, `:day` and `:id`. A token is a whole path segment. An unknown token answers `422`; two patterns that could both serve one URL answer `409`. A fixed path always beats a pattern, so `/about` and `/:article` coexist and `/about` is the page. `status` defaults to `draft`, which has no public address: it is reachable only through the signed `preview_url` this returns. Publish a website page puts it live. **No versioning.** Commune keeps the page you last wrote and nothing else, so keep your site in a repository of your own. A document over 2MB answers `422`. Move images, fonts and shared stylesheets or scripts into Store a website asset and link them. Publishes no event. ## Servers - Production. There is no separate sandbox host. : https://api.usecommune.com (Production. There is no separate sandbox host. ) ## Authentication methods - Api key - Oauth2 ## Parameters ### Headers - **Idempotency-Key** (string) A value of your choosing naming the change this request is making. Send the same value again to retry the same request. Commune replays the answer the first attempt gave instead of making the change twice, and marks the replay with an `Idempotent-Replay: true` response header. Send a different value for a different change: a key reused for a request that differs in any way answers `409`, because replaying an answer to a question you did not ask is a wrong answer you could not detect. A UUID per change is the usual choice. Remembered for 24 hours, per credential, so two credentials choosing the same value never see each other's answers. Required, not optional. - **Commune-Version** (string) The contract version this request is written against. Every version published so far is a release date (`YYYY-MM-DD`), which is why the examples look like one, but the value is an opaque identifier: match it against the versions this API publishes rather than parsing it, because a future one may not be only a date. An unknown value answers `400` with `invalid_version`. Omitting the header pins the request to the version that was current when the API key was issued, so an integration keeps working when a newer version ships. ### Path parameters - **newsletter** (string) The newsletter's `id` (a UUID) or its `handle`. A handle is unique across Commune and is the identifier its public web profile uses, so it is the one to hardcode in an integration. ### Body: application/json (object) - **kind** (string) What a website page is for, which also decides what its `path` means. `page` is a fixed path and anything the creator wants. `newsletter` is the article list, at most one per newsletter, and its path is where Commune points the newsletter's name and avatar. `article` is a URL pattern containing `:article` that renders every article, so its path is a pattern rather than an address. - **path** (string) An absolute path for a `page` or a `newsletter` page, and a URL pattern for an `article` one. Normalised on the way in: a trailing slash is dropped, and a query string or a fragment is refused rather than trimmed, because silently turning `/about?v=2` into `/about` would leave you with a page at an address you did not ask for. - **html** (string) The whole document. At most 2097152 bytes; link media, fonts and shared stylesheets or scripts as assets rather than inlining them. - **meta** (object) Metadata to inject into the page's ``. Omit for none. - **status** (string) Whether a page has a public address. A `draft` is reachable only through its signed `preview_url`; an edit to a `published` page is live on commit, because a creator website has no deploy step. ## Responses ### 201 The page, with its document. #### Body: application/json (object) - **object** (string) Always `site_page`. - **id** (string(uuid)) Stable identifier. - **newsletter** (object | null) The newsletter whose website this page belongs to. A `Ref` unless `newsletter` is named in `?expand=`. - **kind** (string) What a website page is for, which also decides what its `path` means. `page` is a fixed path and anything the creator wants. `newsletter` is the article list, at most one per newsletter, and its path is where Commune points the newsletter's name and avatar. `article` is a URL pattern containing `:article` that renders every article, so its path is a pattern rather than an address. - **path** (string) Where the page answers: an absolute path for a `page` or a `newsletter` page, and a URL pattern for an `article` one. - **status** (string) Whether a page has a public address. A `draft` is reachable only through its signed `preview_url`; an edit to a `published` page is live on commit, because a creator website has no deploy step. - **blocked** (boolean) Whether Commune has taken this page down. A blocked page answers a refusal to visitors, stays out of the sitemap, keeps its address reserved so nothing else can claim it, and cannot be changed or deleted through this API. - **meta** (object) Metadata Commune injects into the page's `` when it serves it: a title, a description, a social image. - **byte_size** (integer) How large the document is, in bytes rather than characters, against a limit of 2097152. - **url** (string(uri) | null) Where the page is served, or null. Null for a draft, for a page Commune has taken down, for an `article` page, which is a pattern rather than one address, and for a newsletter whose website hostname is not live yet. - **preview_url** (string(uri) | null) A signed link that opens this one draft, or null. It names this page and this newsletter, expires after a week, and opens nothing else. Null for a published page and when Commune holds no signing key on this deployment. - **published_at** (string(date-time) | null) When the page first went live. It records the first publication rather than the current state, so unpublishing deliberately leaves it. - **created_at** (string(date-time)) When the page was written. - **updated_at** (string(date-time)) When it last changed. - **html** (string) The whole document, with its CSS and JavaScript inline or linked. At most 2097152 bytes. ### 400 The request was malformed, and the same request will fail the same way until it is changed. `param` names the parameter or header at fault when there is exactly one, and `allowed_values` lists what it accepts when that is a finite set. The code is `bad_request` for every case below except the last. * **A query parameter**: one the operation does not have, a value outside its set, range or format (an unparseable cursor, an unknown `expand` path or `fields` name, an identifier that is not a UUID), or a required one left out, such as `q` on a search or `newsletter` when the credential reaches more than one. * **The request body**: not JSON, not the shape the operation reads, a property it does not write, or a value of the wrong type, length or format. `param` is absent here, since the body is not a parameter, and the message names the property. * **The `Idempotency-Key` header**, on an operation that changes something: missing, or a value this API will not store. * **An unrecognised `Commune-Version`**, which answers with its own code, `invalid_version`, because it is never fixed by changing the body. #### Body: application/json (object) - **error** (object) ### 401 No credential was presented, or it is malformed, unknown, revoked or expired, or it is an access token minted for a different audience. Every one of these answers identically, down to the wording and the headers, so a refusal never confirms that a string was once real. #### Headers - **WWW-Authenticate** (string) The authentication scheme this API accepts, and where to find out how to get a credential for it. Always `Bearer realm="Commune API", resource_metadata="https://api.usecommune.com/.well-known/oauth-protected-resource"`. `resource_metadata` is the RFC 9728 pointer to this API's protected resource metadata, which names the authorization server an OAuth client should send its user to. A client holding an API key can ignore it. The header carries no `error` parameter, not even `error="invalid_token"`, because it describes what this API accepts rather than what was wrong with the credential sent, and the reasons above are deliberately indistinguishable. There is no second scheme and no query-parameter fallback, because a credential that can travel in a URL ends up in access logs and referer headers. #### Body: application/json (object) - **error** (object) ### 402 The credential is allowed to do this but the newsletter's plan does not include it. Two surfaces can answer it: **insights**, the engagement and metrics operations, which are the only reads Commune reserves the right to meter, and **writing**, every operation that changes something. Every other read stays free on every plan, so a credential refused at one of these can still read everything else. The body names the plan the newsletter is on and the plans that would work. One refusal is a feature of the paid plan rather than a charge for API access, and it answers whatever is metered: a newsletter whose plan does not include it may have **one automation active at a time**, so `POST /automations/{automation}/activate` is refused while another is running. That one is also the only `402` a client can clear on its own, by pausing the automation that is running. **This status is predictable and should not be how you discover it.** `GET /newsletters/{newsletter}/entitlements` answers the same question in advance, carrying the same plan list this puts in `allowed_values` and the same sentence it puts in `message`. Read it once at the start of a run rather than finding out in the middle of one. #### Body: application/json (object) - **error** (object) ### 403 The credential is valid but is not allowed to do this. Two codes answer with this status, and `error.code` says which. **`insufficient_scope`: it does not hold the permission.** The operation needs, say, `audience: read` on the newsletter addressed, and this credential holds less than that there. `allowed_values` carries the permission that was needed, and the message says what the credential does hold on that newsletter, because a credential granted the wrong family and a credential belonging to somebody whose standing on the team has narrowed look identical without it. The answer can differ per newsletter: the same credential may be allowed here and refused on the next one it reaches. The same code answers an operation that needs the **account permission** from a credential that does not carry it. That permission is about the person a credential belongs to rather than about any newsletter, so nothing granted on a newsletter adds up to it. It is granted on the credential itself, when a key is minted or when an authorization asks for `account:read`. And it answers a parameter the credential may send, but not with the value it sent: a filter a credential holding only `read` permissions may not use, or an `expand` path whose rows need a permission the operation does not. `param` names the parameter, and `allowed_values` carries what this credential may send instead, or is absent when it may send nothing there at all. **`forbidden`: it may not act here at all.** Either the credential does not reach the newsletter addressed, because it was never granted it or because the person it belongs to can no longer act on it, or it reaches no newsletter at all; `param` is `newsletter`, and `GET /newsletters` lists the ones it does reach. Or, on `DELETE /api-keys/{key}`, the credential named belongs to somebody else. Neither carries `allowed_values`, because there is no value to send instead. #### Body: application/json (object) - **error** (object) ### 404 No such resource, or the key is not allowed to know that it exists. Commune answers `404` rather than `403` where distinguishing the two would leak the existence of private content. #### Body: application/json (object) - **error** (object) ### 409 The request collided with something. On a write this is always the `Idempotency-Key`, in one of two ways, and the message says which. Either the key was already used for a **different** request, which is refused rather than answered with the earlier request's result. Or an earlier request using the same key has not finished, or never reported an outcome, in which case this one was not run and the key becomes usable again shortly. Nothing was changed by a request that answers this. #### Headers - **Retry-After** (integer) Seconds to wait before retrying, on the second case only. #### Body: application/json (object) - **error** (object) ### 422 The request is well formed and every value in it is legal, and the state of what it addresses refuses it anyway. The message says what about that state is in the way. #### Body: application/json (object) - **error** (object) ### 429 Too many requests. Back off and retry after the interval named by the `Retry-After` response header. One of the budgets in `RateLimit-Policy` ran out, and the `RateLimit-*` headers on this response say which and when it resets. #### Headers - **Retry-After** (integer) Seconds to wait before retrying. #### Body: application/json (object) - **error** (object) ### 500 Something failed inside Commune. The request may be retried. #### Body: application/json (object) - **error** (object) [Powered by Bump.sh](https://bump.sh)