Skip to main content
PATCH
/
v2
/
teams
/
{teamId}
Edit a team
curl --request PATCH \
  --url https://rest.forestreet.com/v2/teams/{teamId} \
  --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,
    "events": true,
    "feature-fit": true,
    "due-diligence": true
  },
  "featurePermissions": [
    "notes"
  ],
  "isDemo": true
}
'
{
  "success": false,
  "errorCode": "USER_NOT_CONFIRMED",
  "message": "<string>",
  "detail": {}
}

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
​
domain
string
​
maxUsersCount
integer
Required range: x > 0
​
teamAdmin
string<uuid>
​
theme
string | null
​
explorerPermissions
object

Permission settings for explorer features.

​
featurePermissions
enum<string>[]
Available options:
notes,
rapidReview,
createTopic,
createStudy,
insights,
editStudy,
viewStudyStatus,
manageTeams,
editFeatureArchitecture,
viewFeatureArchitecture,
phraseSearch
​
isDemo
boolean

Response

No content