Skip to content
Docs

Change workspace settings

PATCH
/api/workspaces/{ws}/settings

Change only what's given. Owners and admins only. Hires never claim to be a person, whatever this says; discloseAi is about saying so up front.

Authorization

session
cookiebetter-auth.session_token<token>

Set by POST /api/auth/sign-in/email.

Path Parameters

ws*string

The workspace id (from GET /api/me).

Request Body

application/json
  1. body
discloseAi?boolean

Say it's an AI assistant in first messages to people outside the team (email, WhatsApp).

teamDomains?array<>

Domains your team's own addresses are at. People there aren't outsiders: inviting or first writing to them needs no approval. Empty: the domains of members' sign-in emails.

Itemsitems <= 50

Response Body

The workspace's settings now.

application/json
Example Request
curl -X PATCH 'https://app.useroster.work/api/workspaces/string/settings' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "discloseAi": true,  "teamDomains": [    "acme.com"  ]}

Workspace settings GET

Settings for the whole workspace. `discloseAi`: hires say they're an AI assistant in first messages to people outside the team, on email and WhatsApp. `teamDomains`: the domains your team's own addresses are at; inviting or first writing to people there needs no approval (empty: the domains of members' sign-in emails, leaving out public mail providers).

Known contacts GET

People outside the team the workspace is already in touch with outside Roster: email addresses, domains (everyone there, subdomains included) and phone numbers. A hire's first email, text or help-desk reply to one of them doesn't wait for approval. `source` is `added` (by someone here) or `approval` (added when someone approved a first message to them). Newest first.