Set communication preference
well_set_communication_preferenceSet the channel Well uses to notify the user (the caller only, never another member).
channel: where notifications go: "whatsapp", "email", or "slack" (a direct message from Well in the user's own Slack; only forschedule_run_report).kind: one notification kind (see well_list_communication_kinds), orschedule_run_reportfor the reports of the user's routines, the morning brief included. Omit it to set the default for every notification; a kind's own preference wins over that default.
The call is refused, with the reason, when the kind has no template for the channel (the refusal lists the supported channels) or when the user cannot receive on that channel now, e.g. WhatsApp is not linked. Tell the user the reason; never retry with another channel on your own.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | The notification kind this preference applies to. Omit it to set the default for every notification. | |
| channel | Yes | The channel to send these notifications on. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| idempotency_key | No | Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | ||
| kind | No | The kind the preference applies to, or null for every notification. | |
| error | No | ||
| channel | No | ||
| success | Yes | ||
| reply_lines | No | ||
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| near_candidates | No | ||
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. | |
| near_candidates_truncated | No |