put/projects/{id}/sharingWrite operation

Replace project sharing

Requires exactly one latest strong resource ETag. The cell-local App re-authenticates and atomically compares the tenant-bound revision before mutation.

Required scopes

projects:sharing

Request example

curl --request PUT \
  --url 'https://api.de.teamgrid.app/v1/projects/ID/sharing' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "entries": [
      {
        "permissions": [
          "string"
        ],
        "userId": null,
        "workspaceId": "example"
      }
    ]
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/projects/ID/sharing', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "entries": [
    {
      "permissions": [
        "string"
      ],
      "userId": null,
      "workspaceId": "example"
    }
  ]
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/projects/ID/sharing', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "entries": [
    {
      "permissions": [
        "string"
      ],
      "userId": null,
      "workspaceId": "example"
    }
  ]
}),
})

const result: ApiResponse = await response.json()

teamgrid projects sharing \
  ID \
  --data @payload.json \
  --if-match REVISION

Example response 2xx

{
  "data": {
    "attributes": {
      "availablePermissions": [
        "string"
      ],
      "entries": [
        "ProjectSharingEntry"
      ],
      "revision": "example"
    },
    "id": "string",
    "type": null
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

idpath · requiredIf-Matchheader · required

JSON request bodyValid JSON

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Path parameters

idrequired

string

Stable identifier of the resource in the authenticated workspace.

Headers

If-Matchrequired

string

Exactly one latest strong project ETag. Wildcards, weak validators, lists, and surrounding whitespace are rejected.

Request body

application/json

required

array<object>

The entries associated with this project sharing replace.

Responses

200The request to replace project sharing succeeded. The response contains the canonical public result and request metadata.application/json

Response schemaapplication/json

required

ProjectSharing

Public API representation of project sharing.

required

ResponseMeta

Public API representation of meta.

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

404The tenant-scoped resource does not exist.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

409The request conflicts with the current resource state.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

412The resource changed since the supplied revision.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

428A strong If-Match revision is required.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

502The cell-local application returned an invalid response.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDreplaceProjectSharingOpenAPI JSON ↗

Documentation feedbackWas this page useful?