Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Screenshot Markers

Update a screenshot marker

Update an existing screenshot marker.

patch/projects/{project_id}/screenshots/{screenshot_id}/markers

Path parameters

project_idstring required

Project ID

screenshot_idstring required

Screenshot ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

key_idstring

Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project.

presentationstring

Presentation details of the screenshot marker in JSON format.

Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (x-axis and y-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (w and h in pixels).

Example request

{
  "branch": "my-feature-branch",
  "key_id": "abcd1234abcd1234abcd1234abcd1234",
  "presentation": "{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }"
}

Response

OK

idstring
presentation_typestring

Marker presentation style. The default value is default.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "d2e056aa9e70b01121f41693e344f5ee",
  "presentation": {
    "x": 10,
    "y": 10,
    "w": 10,
    "h": 10
  },
  "presentation_type": "default",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "translation_key": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "home.index.headline",
    "description": "My description for this key...",
    "name_hash": "1b31d2580ce324f246f66b3be00ed399",
    "plural": false,
    "tags": [
      "awesome-feature",
      "needs-proofreading"
    ],
    "data_type": "string",
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z"
  }
}