v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB

Comments

Create a comment

Create a new comment for a key.

post/projects/{project_id}/keys/{key_id}/comments

Path parameters

project_idstring required

Project ID

key_idstring required

Translation Key ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

messagestring required

Comment message

branchstring

specify the branch to use

locale_idsstring[]

specify the locales for the comment

Example request

{
  "message": "Some message...",
  "branch": "my-feature-branch",
  "locale_ids": [
    "someId",
    "someOtherId"
  ]
}

Response

Created

idstring

messagestring

has_repliesboolean

created_atstring date-time

updated_atstring date-time

Example response

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "message": "Some message...",
  "has_replies": true,
  "user": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "locales": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "English",
      "code": "en-GB"
    }
  ]
}