Skip to main content
POST
/
v2
/
teams
/
{teamId}
/
collections
Create a collection
curl --request POST \
  --url https://rest.forestreet.com/v2/teams/{teamId}/collections \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "isPrivate": true,
  "isUserCreated": true,
  "isDefault": true
}'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "createdDate": "<string>",
  "isUserCreated": 123,
  "isDefault": 123,
  "isPrivate": 123
}

Authorizations

x-api-key
string
header
required

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

Path Parameters

teamId
integer
required

ID of the team whose collections are being retrieved.

Required range: x > 0

Body

application/json

Request body schema for creating a new collection.

name
string
required

Name of the new collection.

Minimum length: 1
description
string

Optional description of the new collection.

isPrivate
boolean

Whether the collection is private. Defaults to true.

isUserCreated
boolean

Indicates whether the collection was created by a user.

isDefault
boolean

Indicates whether the collection is set as the default.

Response

Collection created successfully

id
number
required

Unique identifier for the collection.

name
string
required

The name of the collection.

createdDate
string
required

The date when the collection was created.

description
string

Optional description providing additional details about the collection.

isUserCreated
number

Indicates whether the collection was created by a user.

isDefault
number

Indicates whether the collection is set as the default.

isPrivate
number

Indicates whether the collection is private.

I