Notifications API · settings

Serve the organization's customer pages on a subdomain it owns

POST /settings/pages-domain

Serve the organization's customer pages on a subdomain it owns (orders.ridgeline.com): Manifold registers the host with its edge, which will issue and renew its certificate, and answers the records to create at the domain's DNS host — a CNAME from the host to Manifold's edge, and an optional ownership TXT that proves the name before the CNAME moves.

Links keep naming Manifold's pages host until the host is live (POST /settings/pages-domain/check, and a check on an interval). Appends notifications.pages-domain-requested. 409 PagesDomainUnavailable for a host another organization uses or one of Manifold's own; 503 PagesEdgeUnavailable when the edge cannot be reached or the deployment has none. Idempotent by state: adding the host the organization already has answers it as it stands and appends nothing, and any other host while one is held meets 409 PagesDomainExists — remove it first.

Access

Requires settings:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by state: adding the host the organization already has answers it as it stands and appends nothing, and any other host while one is held meets 409 PagesDomainExists — remove it first.

Why every write carries a key: Idempotency and retries.

Facts appended

  • notifications.pages-domain-requested

What a fact is: Facts and the journal.

AI agent tool

No agent tool. Serving every customer page on the merchant's own subdomain means a record at their DNS host: the owner's work in Settings › Branding, where the record is shown to copy.

Connecting an agent: AI agents.

Example

curl
curl -X POST 'https://notifications.getmanifold.io/settings/pages-domain' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "hostname": "orders.ridgeline-outdoor.example"
}'
JavaScript (fetch)
const response = await fetch("https://notifications.getmanifold.io/settings/pages-domain", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "hostname": "orders.ridgeline-outdoor.example"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Request body · application/json
{
  "hostname": "orders.ridgeline-outdoor.example"
}
Response · 200 · application/json
{
  "domain": {
    "id": "pgd_01a159a2-6c1e-7c0d-9a51-3f0e7d3b8a21",
    "hostname": "orders.ridgeline-outdoor.example",
    "status": "pending",
    "records": [
      {
        "purpose": "route",
        "type": "CNAME",
        "name": "orders.ridgeline-outdoor.example",
        "value": "customers.getmanifold.io",
        "required": true
      },
      {
        "purpose": "ownership",
        "type": "TXT",
        "name": "_cf-custom-hostname.orders.ridgeline-outdoor.example",
        "value": "5cc07c04-ea62-4a5a-95f0-419334a875a4",
        "required": false
      }
    ],
    "edgeId": "0d89c70d-ad9f-4843-b99f-6cc0252067e9",
    "requestedAt": "2026-10-30T22:10:00.000Z",
    "problems": [
      "the name does not point at customers.getmanifold.io yet"
    ]
  },
  "available": true,
  "target": "customers.getmanifold.io",
  "origin": "https://pages.getmanifold.io/org_01a156d2-8680-7738-ab2e-ff985e454887"
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: notifications-manager.openapi.json. Base URL https://notifications.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

401

RefusalWhat it meansWhat to do
Unauthorized reason The token is missing, expired or not one Manifold issued.Get a fresh token and send the call again.
TokenAlreadyUsed tokenId A single-use app token was already spent.Mint a new token for this call.

402

RefusalWhat it meansWhat to do
SubscriptionRequired status The organization's subscription has lapsed, so writes are refused.An owner settles billing. Reads still work meanwhile.

403

RefusalWhat it meansWhat to do
TenantRequired userId The token names no organization.Choose the organization, then get a new token.
ScopeRequired required The token's roles do not grant the scope this call needs.Ask an owner or admin for a role that grants it.

409

RefusalWhat it meansWhat to do
PagesDomainExists hostname The request was refused, and nothing changed.Nothing changed. Read the record, then decide.
PagesDomainUnavailable hostname, reason A service this call needs did not answer, so nothing changed.Send the same request again shortly.
MirroredFromSource source This area is fed by your source system until the organization goes live.Make the change in the source system, or go live first.

503

RefusalWhat it meansWhat to do
PagesEdgeUnavailable reason The edge cannot be reached or the deployment has none.Send the same request again shortly.
RequestLogUnavailable tokenId, reason The service could not record the request, so it did nothing.Send the same request again shortly.

How refusals work everywhere: Errors.

Used in