PilotFoxDocs

Set a team's site grants

PUT
/api/v1/orgs/{orgId}/teams/{teamId}/sites

Replaces the sites the team grants its members, each with its role; 400 for a site named twice or not a live site of the organization.

Requires team:update in the organization (an API key, or a signed-in member's role; a member restricted to some sites holds a viewer's permissions here). API keys limited to some sites: 403. Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: team:update

Path Parameters

orgId*string
teamId*string

Request Body

application/json
  1. body
grants*array<>
Itemsitems <= 500

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PUT 'https://pilotfox.app/api/v1/orgs/string/teams/string/sites' \  -H 'Content-Type: application/json' \  -d '{  "grants": [    {      "siteId": "string",      "role": "editor"    }  ]}'
Example Response200
{  "data": {    "grants": [      {        "siteId": "string",        "role": "editor"      }    ]  }}