Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Screenshots

Update a screenshot

Update an existing screenshot.

patch/projects/{project_id}/screenshots/{id}

Path parameters

project_idstring required

Project ID

idstring required

ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

namestring

Name of the screenshot

descriptionstring

Description of the screenshot

filenamestring binary

Screenshot file

Example request

{
  "branch": "my-feature-branch",
  "name": "A screenshot name",
  "description": "A screenshot description",
  "filename": "/path/to/my/screenshot.png"
}

Response

OK

idstring
namestring
descriptionstring
screenshot_urlstring
created_atstring date-time
updated_atstring date-time
markers_countinteger

Example response

{
  "id": "d2e056aa9e70b01121f41693e344f5ee",
  "name": "A screenshot name",
  "description": "A screenshot description",
  "screenshot_url": "http://assets.example.com/screenshot.png",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "markers_count": 0
}