Skip to main content
PATCH
/
projects
/
{project_id}
/
screenshots
/
{screenshot_id}
/
markers
cURL
curl "https://api.phrase.com/v2/projects/:project_id/screenshots/:screenshot_id/markers" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X PATCH \
  -d '{"branch":"my-feature-branch", "key_id":"abcd1234abcd1234abcd1234abcd1234","presentation":"{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }"}' \
  -H 'Content-Type: application/json'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

​
X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

​
project_id
string
required

Project ID

​
screenshot_id
string
required

Screenshot ID

Body

application/json
​
branch
string

specify the branch to use

Example:

"my-feature-branch"

​
key_id
string

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

Example:

"abcd1234abcd1234abcd1234abcd1234"

​
presentation
string

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:

"{ \"x\": 100, \"y\": 100, \"w\": 100, \"h\": 100 }"

Response

OK

​
id
string
​
presentation
object

Coordinates and size of the marker on the screenshot, in pixels.

​
presentation_type
string

Marker presentation style. The default value is default.

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
translation_key
translation_key · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "home.index.headline",
  "description": "My description for this key...",
  "name_hash": "1b31d2580ce324f246f66b3be00ed399",
  "plural": false,
  "use_ordinal_rules": false,
  "tags": ["awesome-feature", "needs-proofreading"],
  "data_type": "string",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}