---
title: "Finalize project background upload"
method: POST
path: "/project/{id}/background-upload/finalize"
tags: ["Projects"]
---

# Finalize project background upload

`POST /project/{id}/background-upload/finalize`

## Request

- Base URL: `https://cloud.kaneo.app/api`
- URL: `https://cloud.kaneo.app/api/project/{id}/background-upload/finalize`
- Auth: HTTP bearer

Save an uploaded image as the project's board background.

## Path parameters

- `id` string, required

## Request body

- object
  - `key` string, required
  - `contentType` string, required
  - `version` string, required
  - `size` number, required

## Response `200`

Finalized project background

- ProjectBackgroundFinalize
  - `url` string, required

## Other responses

- `400`: Invalid image upload request
- `401`: Missing or invalid credentials
- `403`: No access to the project, or missing project:update permission
- `404`: Project not found
- `429`: The API key exceeded its rate limit or usage quota. Wait the number of seconds in Retry-After before retrying. The X-RateLimit headers are sent only when the rate limit was hit.
- `500`: Failed to save the project background

## Changes

- **2026-10-08** `c7b8a842601b`: 5 breaking, 6 info
  - removed the media type `text/plain` for the response with the status `400`
  - removed the media type `text/plain` for the response with the status `403`
  - removed the media type `text/plain` for the response with the status `404`
  - removed the media type `text/plain` for the response with the status `429`
  - …7 more
- **2026-10-08** `2ed51b8af657`: 5 breaking, 5 info
  - removed the media type `application/json` for the response with the status `400`
  - removed the media type `application/json` for the response with the status `401`
  - removed the media type `application/json` for the response with the status `403`
  - removed the media type `application/json` for the response with the status `404`
  - …6 more
- **2026-10-07** `df1439c724ee`: 4 breaking, 5 info
  - removed the media type `text/plain` for the response with the status `400`
  - removed the media type `text/plain` for the response with the status `403`
  - removed the media type `text/plain` for the response with the status `404`
  - removed the media type `text/plain` for the response with the status `500`
  - …5 more
- **2026-09-26** `8972fa938891`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usekaneo/apis/kaneo-api/changes/project/:id/background-upload/finalize/post.md)

---

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