Skip to main content
PATCH
/
v2
/
discovery
/
{marketId}
/
companies
/
reviews
curl --request PATCH \
  --url https://rest.forestreet.com/v2/discovery/{marketId}/companies/reviews \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "reviewStatus": "include",
  "target": {
    "mode": "full"
  }
}'
{
  "metadata": {
    "reviewStatus": "include",
    "mode": "full"
  },
  "data": {
    "updatedCount": 50
  }
}

​
Overview

This endpoint allows you to approve, reject, or request more information about discovered companies during the review phase.
Workflow Step: This is part of Phase 3 (Company Review) of the Market Research Workflow.

​
Usage

Use this endpoint to control which companies proceed to the final analysis phase:
  • Include: Include companies that meet your criteria
  • Exclude: Exclude companies that don’t meet your criteria
  • Unreviewed: Undo previous decisions and re-review companies
Quality Control: This step is crucial for ensuring only relevant companies are included in your market analysis.
Important: This step is optional but recommended for quality control. Once you publish the market, the review phase is complete.

Authorizations

​
x-api-key
string
header
required

Pass a static API key for every request, provided by your customer support.

Path Parameters

​
marketId
string
required

Unique identifier for the market study.

Body

application/json
​
reviewStatus
enum<string>
required

Review status of the company.

Available options:
include,
exclude,
unreviewed
​
target
object
required
  • Option 1
  • Option 2

Response

Company review status updated

​
metadata
object
required
​
data
object
required
⌘I