---
title: "Update Surface"
method: PUT
path: "/v1/projects/{project_id}/surfaces/{slug}"
tags: ["surfaces"]
---

# Update Surface

`PUT /v1/projects/{project_id}/surfaces/{slug}`

## Request

- Base URL: `https://api.sonenta.dev`
- URL: `https://api.sonenta.dev/v1/projects/{project_id}/surfaces/{slug}`
- Auth: none declared

Rename (label) and/or toggle (active) a surface. Deactivation is SOFT —
existing variants are retained and hidden; affected_variants warns how many.

## Path parameters

- `slug` string, required
- `project_id` string, required

## Request body

- SurfaceUpdateIn
  - `label` string, nullable
  - `active` boolean, nullable

## Response `200`

Successful Response

- SurfaceUpdateOut
  - `surfaces` SurfaceOut[], required
    - `slug` string, required
    - `label` string, required
    - `kind` string, required
    - `builtin` boolean, required
    - `active` boolean, required
  - `affected_variants` integer

## Other responses

- `422`: Validation Error

---

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