Product Reviews API

• Create comment

  Create a new comment for a given conversation. The comment is appended to the list of existing comments.

  HTTP method: POST

  Authentication: Business user OAuth Token

  URL: https://api.trustpilot.com/v1/private/conversations/{conversationId}/comments

  Parameters

  • conversationId, Required string

    The ID of the conversation to create a comment for

    Example: .../v1/private/conversations/507f191e810c19729de860ea/comments

  ---

  CURL

  curl -X POST "https://api.trustpilot.com/v1/private/conversations/{conversationId}/comments" \
    -H "Content-Type: application/json" \
    -d '{
      "content": "Thank you for you kind words, we really appreciate it.",
      "integrationId": "IB2478HFAJKN38"
    }' \
    -H "Authorization: Bearer YOUR-ACCESS-TOKEN"

  JavaScript

  const accessToken = "YOUR-ACCESS-TOKEN";
  
  const response = await fetch(
    "https://api.trustpilot.com/v1/private/conversations/{conversationId}/comments",
    {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        Authorization: `Bearer ${accessToken}`,
      },
      body: JSON.stringify({
        "content": "Thank you for you kind words, we really appreciate it.",
        "integrationId": "IB2478HFAJKN38"
      }),
    }
  );
  
  if (!response.ok) {
    throw new Error(`HTTP ${response.status}: ${await response.text()}`);
  }
  
  const data = await response.json();

  Request Body

  {
    "content": "Thank you for you kind words, we really appreciate it.",
    "integrationId": "IB2478HFAJKN38"
  }

  Response

  {
    "commentId": "507f191e810c19729de860ea",
    "createdAt": "2013-09-07T13:37:00",
    "author": {
      "id": "507f191e810c19729de860ea",
      "type": "businessUser"
    },
    "content": "Thank you for you kind words, we really appreciate it."
  }

• Get conversation

  Get a conversation and related comments by ID.

  HTTP method: GET

  Authentication: Business user OAuth Token

  URL: https://api.trustpilot.com/v1/private/conversations/{conversationId}

  Parameters

  • conversationId, Required string

    The ID of the conversation to retrieve

    Example: .../v1/private/conversations/507f191e810c19729de860ea

  ---

  CURL

  curl -X GET "https://api.trustpilot.com/v1/private/conversations/{conversationId}" \
    -H "Authorization: Bearer YOUR-ACCESS-TOKEN"

  JavaScript

  const accessToken = "YOUR-ACCESS-TOKEN";
  
  const response = await fetch(