Skip to main content
PATCH
/
v2
/
discovery
/
{marketId}
/
companies
/
reviews
Update company review status
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": "partial",
    "domains": [
      "<string>"
    ]
  }
}'
{
  "status": "success",
  "message": "<string>",
  "updatedCompaniesCount": 123
}

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

200 - application/json

Company review status updated

​
status
enum<string>
required

Status of the update.

Available options:
success,
error
​
message
string
required

Message indicating the result of the update.

​
updatedCompaniesCount
number
required

Number of companies that had their review status updated.