Skip to main content
PATCH
/
v2
/
markets
/
{marketId}
Update a market
curl --request PATCH \
  --url https://rest.forestreet.com/v2/markets/{marketId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "headerImage": "<string>"
}
'
{
  "success": true,
  "message": "<string>"
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
marketId
integer
required

ID of the market to update.

Required range: x > 0

Body

application/json
​
name
string

Updated name of the market.

​
description
string | null

Updated description of the market. Can be set to null to clear the description.

​
headerImage
string

Updated URL to the market's header image.

Response

Update a market in collection response

​
success
boolean
required

Indicates whether the update operation was successful.

​
message
string
required

Optional message providing additional information about the update operation.