Update project group mapping

PATCH/api/v1/workspaces/{workspace_slug}/group-sync/project-mappings/{mapping_id}/

Update an existing IdP group → project mapping. Supports partial updates.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

mapping_id:requiredstring

The unique identifier of the project group mapping.

Body Parameters

idp_group_name:optionalstring

The name of the IdP group to map.

role:optionalstring

Project role slug to assign to members of the IdP group (e.g. member, admin, guest).

project:optionalstring

Project identifier to map the group to (e.g. ENG). Mutually exclusive with all_projects.

all_projects:optionalboolean

When true, maps the group to all projects in the workspace. Mutually exclusive with project.

Scopes

workspaces.group_sync:write

Update project group mapping

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/project-mappings/661f9511-f30c-52e5-b827-557766551111/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "role": "admin"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/project-mappings/661f9511-f30c-52e5-b827-557766551111/",
    headers={"X-API-Key": "your-api-key"},
    json={"role": "admin"}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/project-mappings/661f9511-f30c-52e5-b827-557766551111/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ role: "admin" }),
  }
);
const data = await response.json();

Response200

{
  "id": "661f9511-f30c-52e5-b827-557766551111",
  "idp_group_name": "engineering",
  "project": "ENG",
  "all_projects": false,
  "role": "admin",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}