Edit a team

Edits a team with the provided details.

Restricted Endpoint: This endpoint is built for Forestreet administration purposes only. It is not intended for public use and should not be accessed by non-administrators. If you believe you need access to this endpoint for legitimate reasons, please contact Forestreet support.

We do not provide external support for this endpoint unless permissions had been negotiated in your contract.

PATCH /v2/teams/{teamId}

Edit a team

cURL

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
  },
  "featurePermissions": [],
  "isDemo": true,
  "teamQuotas": {
    "startDiscovery": 123,
    "createSupplierDossier": 123
  }
}
'

400

{
  "success": false,
  "errorCode": "INVALID_INPUT",
  "message": "Bad Request - Invalid input"
}

Authorizations

apiKeyAuthbearerAuthsessionIdQuery

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.

Show child attributes

featurePermissions · enum<string>[]

Available options: notes, rapidReview, createTopic, createStudy, insights, editStudy, viewStudyStatus, manageTeams, editFeatureArchitecture, viewFeatureArchitecture, phraseSearch

isDemo · boolean

teamQuotas · object

Quota information for a team.

Show child attributes

Response

204

application/json

No content