From ce791e571a1eedd577580b17fb919fcd55f6a70a Mon Sep 17 00:00:00 2001 From: Joram Wilander Date: Tue, 16 Sep 2025 08:58:31 -0400 Subject: [PATCH] Update api user endpoint docs to fix useAutomaticTimezone type and document more fields (#33901) --- api/v4/source/definitions.yaml | 24 +++++++++++++++++++++++- api/v4/source/users.yaml | 3 ++- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/api/v4/source/definitions.yaml b/api/v4/source/definitions.yaml index 810a5681994..b9a2ad6bb7a 100644 --- a/api/v4/source/definitions.yaml +++ b/api/v4/source/definitions.yaml @@ -2689,11 +2689,33 @@ components: type: string description: Set to "true" to enable mentions for first name. Defaults to "true" if a first name is set, "false" otherwise. + auto_responder_message: + type: string + description: The message sent to users when they are auto-responded to. + Defaults to "". + push_threads: + type: string + description: Set to "all" to enable mobile push notifications for followed threads and "none" to disable. + Defaults to "all". + comments: + type: string + description: Set to "any" to enable notifications for comments to any post you have + replied to, "root" for comments on your posts, and "never" to disable. Only + affects users with collapsed reply threads disabled. + Defaults to "never". + desktop_threads: + type: string + description: Set to "all" to enable desktop notifications for followed threads and "none" to disable. + Defaults to "all". + email_threads: + type: string + description: Set to "all" to enable email notifications for followed threads and "none" to disable. + Defaults to "all". Timezone: type: object properties: useAutomaticTimezone: - type: boolean + type: string description: Set to "true" to use the browser/system timezone, "false" to set manually. Defaults to "true". manualTimezone: diff --git a/api/v4/source/users.yaml b/api/v4/source/users.yaml index 504adc820b1..3d8075fe4d8 100644 --- a/api/v4/source/users.yaml +++ b/api/v4/source/users.yaml @@ -183,9 +183,10 @@ Get a page of a list of users. Based on query string parameters, select users from a team, channel, or select users not in a specific channel. - Since server version 4.0, some basic sorting is available using the `sort` query parameter. Sorting is currently only supported when selecting users on a team. + Some fields, like `email_verified` and `notify_props`, are only visible for the authorized user or if the authorized user has the `manage_system` permission. + ##### Permissions Requires an active session and (if specified) membership to the channel or team being selected from.