Skip to main content
POST
cURL

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
key_id
string
required

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

Example:

"abcd1234abcd1234abcd1234abcd1234"

branch
string

specify the branch to use

Example:

"my-feature-branch"

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

Created

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: