POST
/
v2
/
teams
Create a new team
curl --request POST \
  --url https://rest.forestreet.com/v2/teams \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "domain": "<string>",
  "maxUsersCount": 1,
  "teamAdmin": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "theme": "<string>",
  "explorerPermissions": {
    "table": true,
    "bubble": true,
    "feature-fit": true,
    "events": true,
    "due-diligence": true
  },
  "featurePermissions": [
    "notes"
  ],
  "isDemo": true
}'
{
  "id": 123,
  "name": "<string>",
  "domain": "<string>",
  "filePath": "<string>",
  "explorerPermissions": {
    "table": true,
    "bubble": true,
    "events": true,
    "feature-fit": true,
    "due-diligence": true
  },
  "accessExpired": 123,
  "maxUsers": 123,
  "isDemo": 123,
  "isDefault": 123,
  "theme": "<string>"
}

Authorizations

x-api-key
string
header
required

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

Body

application/json
name
string
required
domain
string
required
maxUsersCount
integer
required
Required range: x > 0
explorerPermissions
object
required
featurePermissions
enum<string>[]
required
teamAdmin
string<uuid>
theme
string | null
isDemo
boolean | null

Response

Team created successfully

id
number
required

Unique identifier of the team.

name
string | null
required

Name of the team.

domain
string | null
required

Domain of the team.

filePath
string | null
required

File path for the team.

explorerPermissions
object
required

Permission settings for explorer features.

accessExpired
number
required

Access expiration status.

maxUsers
number
required

Maximum number of users allowed.

isDemo
number
required

Demo status of the team.

theme
string | null
required

Theme settings for the team.

isDefault
number

Default state of the team.