EvoHub Docs Sign in

Status API › Pages

Update a page

Use with AI
View as MarkdownThis page as plain text, for pasting into an AI tool Open in ClaudeAsk Claude questions about this page Open in ChatGPTAsk ChatGPT questions about this page
Connect to Cursor / VS Code / ClaudeSearch and read these docs from your AI tool (MCP server)

MCP server URL

https://docs-dev.evohub.io/mcp

Add to CursorAdd to VS Code

Claude Code

claude mcp add --transport http evohub-docs-docs https://docs-dev.evohub.io/mcp

Claude (claude.ai and Claude Desktop): Settings → Connectors → Add custom connector, and paste the URL above.

Claude Desktop — claude_desktop_config.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://docs-dev.evohub.io/mcp"
      ]
    }
  }
}

Cursor — ~/.cursor/mcp.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

VS Code — .vscode/mcp.json

{
  "servers": {
    "evohub-docs-docs": {
      "type": "http",
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

llms.txtllms-full.txt

PUT/api/v1/pages/{pageID}

A partial update: a field left out keeps its stored value. logo_url and brand_color clear on null; theme: "" means auto. slug and team_id cannot change here: sent with a different value they are refused with VALIDATION_ERROR, sent with the stored value they are accepted.

Permission (API-key scope): status:page:write.

Authorization

Any one of:

Parameters

Path parameters

  • pageID string (uuid) required
    The status page's id (a UUID).
    Example: 3f6c2a1e-8b4d-4f7a-9c21-5d0e7a9b1c42

Request body required

Content type: application/json

Type: PageUpdate

  • name string
    Left out keeps the stored name; may not be empty.
  • logo_url string | null
    Left out keeps the stored logo; null clears it.
  • brand_color string | null
    Left out keeps the stored colour; null clears it.
  • is_public boolean
    Left out keeps the stored visibility.
    Default: true
  • theme string
    Left out keeps the stored theme; "" means auto.
    One of: auto light dark
  • slug string
    Cannot change. A different value is refused (VALIDATION_ERROR); the stored value is accepted.
  • team_id string | null
    Cannot change here. A different value is refused (VALIDATION_ERROR); the stored value is accepted.

Responses

200

The page.

Content type: application/json

Type: object

  • data Page required
    Show Page properties
    • id string (uuid) required
    • org_id string required
    • team_id string required
      The team that manages the page; "" for the whole organization. Never affects the public page.
    • slug string required
      Unique in the organization.
    • name string required
    • logo_url string
    • favicon_url string
    • brand_color string
      #rrggbb.
    • custom_domain string
    • is_public boolean required
      Whether visitors can read it.
    • theme string required
      One of: auto light dark
    • site_theme SiteTheme required
      Show SiteTheme properties
      • font string
        "" is the system font.
        One of: Inter Roboto Open Sans Lato Source Sans 3 IBM Plex Sans Nunito Sans Work Sans Manrope DM Sans Plus Jakarta Sans Figtree Geist Poppins Merriweather Source Serif 4 Lora
      • radius string
        One of: none small medium large · Default: medium
      • background string
        One of: default tinted slate warm · Default: default
      • mode string
        The same setting as the page's theme (system there is auto).
        One of: system light dark · Default: system
    • subscriptions_enabled boolean
    • reply_to_email string
      Where replies to subscriber emails go.
    • page_description string
    • footer_text string
    • support_url string
    • support_label string
    • privacy_url string
    • terms_url string
    • ga_tag string
      The older field for the Google Analytics id, kept in step with analytics.ga4_measurement_id.
    • search_indexable boolean
    • history_window_days integer
      How far back the public page shows past incidents.
      One of: 30 90
    • product_groups boolean
      Groups fold into one line each on the public page.
    • open_groups array of string
      Groups that start open.
    • product_pages boolean
      Each group has a page of its own.
    • header_links array of HeaderLink
      Max items: 5
      Show HeaderLink properties
      • label string required
        One line of text.
        Min length: 1 · Max length: 40
      • url string (uri) required
        An https:// URL.
        Max length: 2048
    • show_page_name boolean
      false shows the logo alone.
    • analytics AnalyticsSettings
      Show AnalyticsSettings properties
      • enabled boolean
        Whether visitor analytics are collected.
      • retention_days integer
        How long daily counts are kept.
        One of: 30 90 180 365 730
      • ga4_measurement_id string
        A Google Analytics 4 id (G-…) the public page loads, or "".
      • honor_privacy_signals boolean
        Load Google Analytics only for visitors who sent neither DNT: 1 nor Sec-GPC: 1.
    • created_at string (date-time) required
    • updated_at string (date-time) required
  • success boolean required
    Value: true

400

A field is missing or invalid (VALIDATION_ERROR); the message names it, or the body is not valid (INVALID_BODY).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

401

No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

403

The key lacks the scope this endpoint needs (FORBIDDEN).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

404

No such item, or one the caller cannot see (NOT_FOUND).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

429

Too many requests (RATE_LIMITED). Wait Retry-After seconds.

Headers

  • Retry-After integer
    Seconds to wait.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

500

Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.

Example request

curl -X PUT 'https://evohub.io/api/v1/pages/3f6c2a1e-8b4d-4f7a-9c21-5d0e7a9b1c42' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <TOKEN>' \
  -d '{
  "name": "Acme Status",
  "theme": "dark",
  "logo_url": "https://assets.evohub.io/logos/acme.png",
  "is_public": true
}'

Last updated