---
title: "PATCH /v1/backgrounds/{id}"
method: PATCH
path: "/v1/backgrounds/{id}"
---

# PATCH /v1/backgrounds/{id}

`PATCH /v1/backgrounds/{id}`

## Request

- Base URL: `https://api.picsha.ai`
- URL: `https://api.picsha.ai/v1/backgrounds/{id}`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `metadata` object

## Response `200`

Default Response

- object
  - `id` string, required
  - `name` string, required
  - `s3Key` string, required
  - `mimeType` string, required
  - `width` number, nullable, required
  - `height` number, nullable, required
  - `metadata` object, nullable, required
  - `createdAt` string, required
  - `updatedAt` string, required

## Other responses

- `404`: Default Response
- `500`: Default Response

---

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