post https://api.textunited.com/segments/projects//segments/comments
This endpoint allows users to add comments to specific segments within a TextUnited project using the project's unique TextUnited ID. For a comprehensive guide on adding comments by TextUnited IDs, including how to structure your requests, refer to the Adding Comments by TextUnited ID guide.
Instructions
To test the functionality of your request with a specific path parameter, ensure that your request includes the necessary headers. Then, proceed to test the request directly on the platform:
- Navigate to the HEADERS section below the Request Body section:
- Enter the "Content-Type" header with the value "application/json".
- Include your "Authorization" token using either Basic Auth or JWT Access Token. For detailed instructions on obtaining these tokens, refer to the documentation on Obtaining your API key and company ID and Obtaining your JWT token.
- To configure the path parameter:
- Locate the input field designated for the
{textunited-project-id}parameter in the "Path Parameter" section, found under the "Request Body" section.- Enter your desired value for
{textunited-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:
| Parameter | Type | Description |
|---|---|---|
segmentCustomId | String | Specifies the custom ID of the segment to which the comment is being added. |
targetLanguageCode | String | Indicates the target language code of the project version where the segment resides. |
commentText | String | Contains the actual text of the comment being added to the segment. |
commentAuthor | String | Provides the name or nickname of the person who is adding the comment. |