Update the group sync configuration

PATCH/api/v2/workspaces/{slug}/group-sync/config/

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.

Body Parameters

auto_remove:optionalboolean

Whether auto remove.

default_workspace_role_slug:optionalstring

The default workspace role slug.

Nullable.

group_attribute_key:optionalstring

The group attribute key.

Maximum 255 characters.

is_enabled:optionalboolean

Whether the rule is switched on.

sync_offline:optionalboolean

Whether sync offline.

sync_on_login:optionalboolean

Whether sync on login.

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 the group sync configuration

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/group-sync/config/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "auto_remove": false,
  "default_workspace_role_slug": "example",
  "group_attribute_key": "example"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/group-sync/config/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "auto_remove": False,
        "default_workspace_role_slug": "example",
        "group_attribute_key": "example"
    },
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v2/workspaces/my-team/group-sync/config/", {
  method: "PATCH",
  headers: {
    "X-Api-Key": "your-api-key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    auto_remove: false,
    default_workspace_role_slug: "example",
    group_attribute_key: "example",
  }),
});
const data = await response.json();

Response200

{
  "auto_remove": false,
  "default_workspace_role_slug": "example",
  "group_attribute_key": "example",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_enabled": false,
  "sync_offline": false,
  "sync_on_login": false
}