---
title: "Update Portal"
method: PATCH
path: "/api/py/portals/{portal_id}"
tags: ["portals"]
---

# Update Portal

`PATCH /api/py/portals/{portal_id}`

## Request

- Base URL: `https://api.getauctor.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getauctor.com/api/py/portals/{portal_id}`
- Auth: none declared

## Path parameters

- `portal_id` string, uuid, required

## Request body

- UpdatePortalRequest: Omitted fields stay unchanged; an explicit ``null`` clears a nullable field.
  - `title` string, nullable
  - `description` string, nullable
  - `accent_color` string, nullable
  - `font_family` 'sans' | 'serif' | 'mono' | 'custom', nullable
  - `font_bucket_path` string, nullable
  - `icon_bucket_path` string, nullable
  - `landing_file_id` string, uuid, nullable

## Response `200`

Successful Response

- Portal
  - `can_manage` boolean, required
  - `can_edit_metadata` boolean, required
  - `can_delete` boolean, required
  - `id` string, uuid, required
  - `title` string, required
  - `description` string, nullable, required
  - `landing_file_id` string, uuid, nullable, required
  - `landing_page` PortalLandingPage, required
    - `file_id` string, uuid, required
    - `title` string, required
    - `last_updated_at` string, date-time, required
  - `accent_color` string, nullable, required
  - `effective_accent_color` string, required
  - `default_accent_color` string, required
  - `font_family` 'sans' | 'serif' | 'mono' | 'custom', required
  - `custom_font_format` 'woff2' | 'truetype' | 'opentype', nullable, required
  - `custom_font_url` string, nullable, required
  - `has_custom_font` boolean, required
  - `icon_url` string, nullable, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `413`: Request Entity Too Large
- `422`: Validation Error
- `500`: Internal Server Error

## Changes

- **2026-10-27** `3245ffb53690`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/getauctor/apis/getauctor-api/changes/api/py/portals/:portal_id/patch.md)

---

[API](https://skmtc.dev/getauctor/apis/getauctor-api.md) - [All operations](https://skmtc.dev/getauctor/apis/getauctor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getauctor/apis/getauctor-api/revisions/be39c59c13f6?raw)