This endpoint allows users to add comments to specific segments within a translation project, identified by the project's custom ID. For a detailed guide on adding comments by custom IDs, including how to structure your requests, see the Adding Comments by Custom ID guide.

ℹ️

Instructions

Ensure that your request includes the necessary headers. To test the request directly on the platform:

  1. Navigate to the HEADERS section below the Request Body section.
  2. To test the functionality of your request with a specific path parameter:
    • Locate the input field designated for the {custom-project-id} parameter in the "Path Parameter" section, found under the "Request Body" section.
    • Enter your desired value for {custom-project-id} in this input field.
    • Execute the test directly on the platform by clicking the "Try It!" button at the top-right of your screen to initiate the request and view your response.

❗️

Sample Request and Response

To see a sample request and response, click the "EXAMPLES" dropdown at the top-right of your screen.

Request Body

The request should include the following parameters:

ParameterTypeDescription
segmentCustomIdStringSpecifies the custom ID of the segment to which the comment is being added.
targetLanguageCodeStringIndicates the target language code of the project version where the segment resides.
commentTextStringContains the actual text of the comment being added to the segment.
commentAuthorStringProvides the name or nickname of the person who is adding the comment.
Language
Click Try It! to start a request and see the response here!