Skip to main content
POST
Call notification_preference.set

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Maximum string length: 128

Body

application/json
kind_group_key
string
required

The notification group to change — one of the keys the notifications settings page listed. The database's own foreign key refuses an unknown one rather than guessing.

Maximum string length: 120
channel
enum<string>
required

Which delivery channel this preference is about.

Available options:
in_app,
email,
digest,
sms
enabled
boolean
required

true to receive this group on this channel; false to stop.

workspace_scoped
boolean

true to set the preference for the CURRENT workspace only; leave it out for the whole account. The workspace itself is resolved from the session, never passed.

workspace
string

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Minimum string length: 1

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

The tool ran and answered.

ok
boolean
required
kind_group_key
string
required
channel
string
required
enabled
boolean
required
workspace_scoped
boolean
required
workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.