---
title: "Set the roster-sync policy (who joins from Slack)"
method: PUT
path: "/v1/roster-sync-policy"
tags: ["roster-sync-policy"]
---

# Set the roster-sync policy (who joins from Slack)

`PUT /v1/roster-sync-policy`

## Request

- Base URL: `https://api.patricia.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.patricia.app/v1/roster-sync-policy`
- Auth: HTTP bearer

Set which Slack member tiers join Patricia on roster sync. Turning guests off (the default) means no single- or multi-channel guest is ever added, and any guest added by an earlier sync is deactivated on the next sync. Admin only.

## Headers

- `X-Tenant-Id` string, nullable

## Request body

- RosterSyncPolicyBody: Admin request body to set the roster-sync policy (who joins from Slack).
  - `include_full_members` boolean: Include full workspace members when syncing the team list.
  - `include_multi_channel_guests` boolean, nullable: Include multi-channel Slack guests. Either guest option also includes Teams guests.
  - `include_single_channel_guests` boolean, nullable: Include single-channel Slack guests. Either guest option also includes Teams guests.
  - `include_guests` boolean, nullable
  - `admins_only` boolean: Sync only workspace owners and admins. Guests remain excluded.

## Response `200`

Successful Response

- RosterSyncPolicyResponse: The tenant's effective roster-sync policy (admin view).
  - `include_full_members` boolean, required
  - `include_multi_channel_guests` boolean, required
  - `include_single_channel_guests` boolean, required
  - `admins_only` boolean, required
  - `include_guests` boolean, required

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden. Inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, TENANT_ACCESS_REQUIRED, ROLE_UNRESOLVED)
- `409`: Conflict
- `422`: Validation error

---

[API](https://skmtc.dev/patricia/apis/patricia-api.md) · [All operations](https://skmtc.dev/patricia/apis/patricia-api/llms.txt) · [OpenAPI document](https://skmtc.dev/patricia/apis/patricia-api/revisions/0dfb44495ea1?raw)