---
title: "Update a screenshot"
method: PUT
path: "/projects/{project_id}:{branch}/screenshots/{screenshot_id}"
tags: ["Screenshots"]
---

# Update a screenshot

`PUT /projects/{project_id}:{branch}/screenshots/{screenshot_id}`

## Request

- Base URL: `https://api.lokalise.com/api2`
- URL: `https://api.lokalise.com/api2/projects/{project_id}:{branch}/screenshots/{screenshot_id}`
- Auth: API key in header `X-Api-Token`

Updates the properties of a screenshot. Requires *Manage screenshots* admin right.

Requires <code>write_screenshots</code> OAuth access scope.

## Path parameters

- `project_id` string, required
- `branch` string, required
- `screenshot_id` number, required

## Request body

- object
  - `title` string: Set screenshot title (optional).
  - `description` string: Set screenshot description.
  - `key_ids` string[]: Attach the screenshot to key IDs specified.
  - `tags` string[]: List of tags to add to the uploaded screenshot.

## Response `200`

OK

- object
  - `project_id` string
  - `screenshot` Screenshots
    - `screenshot_id` number: A unique identifier of the screenshot.
    - `key_ids` unknown[]: List of key identifiers, the screenshot is attached to.
      - unknown
    - `keys` object[]: List of key keys with coordinates.
      - `key_id` number: A unique identifier of the key.
      - `coordinates` object: Key coordinates of the key area
        - `left` number: <code>x</code> position of the left-top corner
        - `top` number: <code>y</code> position of the left-top corner
        - `width` number: width (pixels) of the area
        - `height` number: height (pixels) of the area
    - `url` string: Link to the screenshot.
    - `title` string: Screenshot title.
    - `description` string: Description of the screenshot.
    - `screenshot_tags` unknown[]: List of screenshot tags.
      - unknown
    - `width` number: Width of the screenshot, in pixels.
    - `height` number: Height of the screenshot, in pixels.
    - `created_at` string: Creation date of the screenshot.
    - `created_at_timestamp` number: Unix timestamp when the screenshot was created.

---

[API](https://skmtc.dev/lokalise/apis/projects-with-branches.md) - [All operations](https://skmtc.dev/lokalise/apis/projects-with-branches/llms.txt) - [OpenAPI document](https://skmtc.dev/lokalise/apis/projects-with-branches/revisions/7ed3f978a361?raw)