Update a workspace mapping

PATCH/api/v2/workspaces/{slug}/group-sync/workspace-mappings/{pk}/

Group sync maps identity-provider groups onto Plane workspace and project roles.

Path Parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs — in https://app.plane.so/my-team/projects/, the slug is my-team.

pk:requiredstring (uuid)

The workspace mapping id.

Body Parameters

idp_group_name:optionalstring

The idp group name.

Maximum 255 characters.

role_slug:optionalstring

The role slug.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: created_at, id, idp_group_name, role_slug.

Scopes

workspaces.group_sync:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan or is switched off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	A business rule blocks the write — see the notes above.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Update a workspace mapping

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/group-sync/workspace-mappings/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "idp_group_name": "example",
  "role_slug": "example"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/group-sync/workspace-mappings/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "idp_group_name": "example",
        "role_slug": "example"
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/group-sync/workspace-mappings/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      idp_group_name: "example",
      role_slug: "example",
    }),
  },
);
const data = await response.json();

Response200

{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "idp_group_name": "example",
  "role_slug": "example"
}