Update workspace group mapping

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

Update an existing IdP group → workspace role 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 workspace group mapping.

Body Parameters

idp_group_name:optionalstring

The name of the IdP group to map.

role:optionalstring

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

Scopes

workspaces.group_sync:write

Update workspace group mapping

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/workspace-mappings/772g0622-g41d-63f6-c938-668877662222/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "role": "member"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/workspace-mappings/772g0622-g41d-63f6-c938-668877662222/",
    headers={"X-API-Key": "your-api-key"},
    json={"role": "member"}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/workspace-mappings/772g0622-g41d-63f6-c938-668877662222/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ role: "member" }),
  }
);
const data = await response.json();

Response200

{
  "id": "772g0622-g41d-63f6-c938-668877662222",
  "idp_group_name": "leadership",
  "role": "member",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}