roster-sync-policy

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

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.

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

Headers

X-Tenant-Idstring nullable

Request body

include_full_membersboolean

Include full workspace members when syncing the team list.

include_multi_channel_guestsboolean nullable

Include multi-channel Slack guests. Either guest option also includes Teams guests.

include_single_channel_guestsboolean nullable

Include single-channel Slack guests. Either guest option also includes Teams guests.

include_guestsboolean nullable
admins_onlyboolean

Sync only workspace owners and admins. Guests remain excluded.

Response

Successful Response

include_full_membersboolean required
include_multi_channel_guestsboolean required
include_single_channel_guestsboolean required
admins_onlyboolean required
include_guestsboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.