---
title: "Call notification_preference.set"
method: POST
path: "/api/v1/tools/notification_preference.set"
tags: ["notification_preference"]
---

# Call notification_preference.set

`POST /api/v1/tools/notification_preference.set`

## Request

- Base URL: `https://app.goosybear.ai`
- URL: `https://app.goosybear.ai/api/v1/tools/notification_preference.set`
- Auth: HTTP bearer

Turn the member's own recurring messages and notifications on or off: the weekly digest of their planned week, Goosy's check-ins, approvals, failed publishes — 'mute the digest of my planned week', 'stop Goosy's progress nudges', 'I want a text when something needs me'. Turns one of the signed-in person's OWN notification groups on or off for one channel, for the whole account or just the current workspace; the group and its channel are in `kind_group_key`'s description, and `notification_settings.status` lists every group. It never changes what anyone else receives, and never changes the account-wide default. Not for the Monday briefing Goosy writes for the account — that is `briefing.set` — for how often Goosy checks in across the account, which is `assistant_preference.set`, or for reading what they get today, which is `notification_settings.status`.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one.

## Headers

- `x-request-id` string

## Request body

- object
  - `kind_group_key` string, required: The notification group to change: `cadence_digest` for the weekly digest of the planned week (channel `digest`), `goosy_checkins` for Goosy's own check-ins and nudges in the pane (channel `in_app`), or another key `notification_settings.status` lists. The database's own foreign key refuses an unknown one rather than guessing.
  - `channel` 'in_app' | 'email' | 'digest' | 'sms', required: Which delivery channel this preference is about.
  - `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.

## Response `200`

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.

- union
  - object: The tool ran and answered.
    - `ok` true, 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.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

---

[API](https://skmtc.dev/goosybear/apis/goosy-bear-api.md) · [All operations](https://skmtc.dev/goosybear/apis/goosy-bear-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goosybear/apis/goosy-bear-api/revisions/6d82fb124064?raw)