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

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
collectionId
integer
required

ID of the collection where the new market will be created.

Required range: x > 0

Body

application/json
​
name
string
required

Name of the new market.

​
subtitle
string

Subtitle of the new market.

​
description
string

Description of the new market.

​
thumbnailSrc
string

URL to the new market's header image.

Response

200 - application/json

Create a market in collection response

​
success
boolean
required

Indicates whether the creation operation was successful.

​
message
string
required

Optional message providing additional information about the creation operation.

​
marketId
number
required

Unique identifier of the newly created market.