Zulip

Parámetros de entrada

• alert_wordsstring[]Obligatorio

  An array of strings to be added to the user's set of configured alert words. Strings already present in the user's set of alert words are ignored. Alert words are case insensitive.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• appidstringObligatorio

  The ID of the Zulip app that is making the request. Required as of Zulip 8.0 (feature level 223).

• tokenstringObligatorio

  The APNs device token provided by the device.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• stream_idintegerObligatorio

  The ID of the target channel to add as a default stream. Default streams are automatically subscribed to all new users in the organization.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• patternstringObligatorio

  The Python regular expression that should trigger the linkifier. Use named groups (e.g., (?P<id>[0-9]+)) to capture parts of the match that can be used in the URL template.

• url_templatestringObligatorio

  The RFC 6570 compliant URL template used for the link. Insert content from named groups in the pattern using {name_of_group}. This replaced url_format_string in Zulip 7.0 (feature level 176).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The user-facing name for custom navigation views. Omit this field for built-in views.

• fragmentstringObligatorio

  A unique identifier for the view, used to determine navigation behavior when clicked. Clients should use this value to navigate to the corresponding URL hash.

• is_pinnedbooleanObligatorio

  Determines whether the view appears directly in the sidebar or is hidden in the 'More Views' menu. True means pinned and visible in the sidebar, False means hidden and accessible via the 'More Views' menu.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emoji_codestring

  A unique identifier defining the specific emoji codepoint within the namespace of the reaction_type. Optional for most cases, but important when upvoting an existing reaction to ensure correct interpretation.

• emoji_namestringObligatorio

  The target emoji's human-readable name (e.g., 'octopus', 'smile', 'thumbs_up'). To find an emoji's name, hover over a message to reveal reaction options.

• message_idintegerObligatorio

  The target message's ID to add the reaction to.

• reaction_typestring

  Type of emoji namespace. Supported values: 'unicode_emoji' (dash-separated hex Unicode codepoints), 'realm_emoji' (custom emoji ID), 'zulip_extra_emoji' (special Zulip emoji). Defaults to 'unicode_emoji' if not specified.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• stream_idintegerObligatorio

  The ID of the channel to archive.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• narrowobject[]Obligatorio

  List of narrow filter objects defining the search criteria. See Zulip's narrow documentation for supported operators.

• msg_idsinteger[]Obligatorio

  List of message IDs to check against the narrow filter.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• voice_onlyboolean

  Configures whether the call is voice-only; if true, disables cameras for all users. Only the call creator/moderator can edit this configuration. Available in Zulip 10.0 (feature level 337) and later.

• meeting_namestringObligatorio

  Meeting name for the BigBlueButton video call.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the new channel to create. This is a required field.

• announceboolean

  Whether the notification bot will send an announcement about the new channel's creation. Defaults to false.

• folder_idinteger

  Adds the newly created channel to the specified channel folder ID for organization.

• descriptionstring

  The description for the new channel in text/markdown format. Describes the purpose and content of the channel.

• invite_onlyboolean

  Whether the newly created channel will be a private channel. Private channels require an invitation to join. Defaults to false (public channel).

• subscribersinteger[]Obligatorio

  A list of user IDs to be subscribed to the new channel. This is a required field. You can get user IDs from the list users endpoint.

• is_web_publicboolean

  Whether the newly created channel will be web-public, meaning anyone can read messages without being logged in. Note that creating web-public channels requires specific server and organization settings. Defaults to false.

• topics_policystringenum

  Policy for how topics work in the channel.

  inheritallow_empty_topicdisable_empty_topicempty_topic_only
• is_default_streamboolean

  Whether the newly created channel will be added as a default channel for new users joining the organization. Defaults to false.

• message_retention_daysany

  Number of days that messages sent to this channel will be stored before being automatically deleted by the message retention policy. Special values: 'realm_default' (use organization setting), 'unlimited' (retain forever). Can also be an integer for specific number of days.

• history_public_to_subscribersboolean

  Whether the channel's message history should be available to newly subscribed members. If true, new subscribers can see all past messages. If false, users can only see messages sent after they subscribed. This is relevant for private channels.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the channel folder. Value cannot be an empty string. Clients should use the max_channel_folder_name_length returned by the POST /register endpoint to determine the maximum channel folder name length.

• descriptionstring

  The description of the channel folder. Can be an empty string if no description is desired. Clients should use the max_channel_folder_description_length returned by the POST /register endpoint to determine the maximum channel folder description length.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• hintstring

  The help text to be displayed for the custom profile field in user-facing settings UI

• namestring

  The name of the custom profile field, which will appear in user-facing settings UI and in user profiles

• requiredboolean

  Whether an organization administrator has configured this profile field as required. Users without values for required fields will see a prominent banner

• field_dataobject

  Additional configuration for field types 3 (Dropdown) and 7 (External account). For Dropdown, this is a JSON dictionary defining the choices and their display order

• field_typeintegerObligatorioenum

  The type of custom profile field to create. Options: 1=Short text, 2=Paragraph, 3=Dropdown, 4=Date picker, 5=Link, 6=Person picker, 7=External account, 8=Pronouns

  12345678
• editable_by_userboolean

  Whether regular users can edit this profile field on their own account. Organization administrators can always edit custom profile fields for any user

• use_for_user_matchingboolean

  Whether this custom profile field should be used to match users in typeahead suggestions. Only allowed for Short Text and External Account profile field types

• display_in_profile_summaryboolean

  Whether clients should display this profile field in a summary section of a user's profile. At most 2 profile fields may have this property be true. Paragraph and Person picker types are not supported for profile summaries

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• draftsobject[]Obligatorio

  A list of draft objects to create. Each draft contains type, recipients, topic, and content.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• group_idsinteger[]

  A list containing the IDs of the user groups that the newly created user will be automatically added to if the invitation is accepted. If the list is empty, then the new user will not be added to any user groups. The acting user must have permission to add users to the groups listed.

• invite_asstringenum

  Organization-level role for the invited user.

  owneradministratormoderatormemberguest
• stream_idsinteger[]

  A list containing the IDs of the channels that the newly created user will be automatically subscribed to if the invitation is accepted, in addition to any default channels. Requested channels must either be default channels for the organization, or ones the acting user has permission to add subscribers to.

• invite_expires_in_minutesinteger

  The number of minutes before the invitation will expire. If null, the invitation will never expire. If unspecified, the server will use a default value (typically 14400, i.e. 10 days).

• welcome_message_custom_textstring

  Custom message text, in Zulip Markdown format, to be sent by the Welcome Bot to new users that join the organization via this invitation. Maximum length is 8000 characters. Only organization administrators can use this feature. Null uses the organization's default, empty string sends no custom message.

• include_realm_default_subscriptionsboolean

  Boolean indicating whether the newly created user should be subscribed to the default channels for the organization. Defaults to false if not specified.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• notestring

  A note associated with the reminder shown in the Notification Bot message. This field was added in Zulip 11.0 (feature level 415).

• message_idintegerObligatorio

  The ID of the previously sent message to reference in the reminder message.

• scheduled_delivery_timestampintegerObligatorio

  The UNIX timestamp for when the reminder will be sent, in UTC seconds.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestringObligatorio

  The title of the saved snippet.

• contentstringObligatorio

  The content of the saved snippet in Zulip-flavored Markdown format. Clients should insert this content into a message when using a saved snippet.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• toanyObligatorio

  The scheduled message's tentative target audience. For channel messages, provide the integer ID of the channel. For direct messages, provide a list containing integer user IDs.

• typestringObligatorioenum

  The type of scheduled message to be sent. Use "direct" for a direct message and "stream" or "channel" for a channel message. Note that "private" is supported for backward compatibility but "direct" is preferred.

  directchannelstreamprivate
• topicstring

  The topic of the message. Only required for channel messages (type "stream" or "channel"), ignored otherwise. When topics are required, this cannot be empty or "(no topic)".

• contentstringObligatorio

  The content of the message. Clients should use the max_message_length returned by the POST /register endpoint to determine the maximum message size.

• read_by_senderboolean

  Whether the message should be initially marked read by its sender. If unspecified, the server uses a heuristic based on the client name and the recipient.

• scheduled_delivery_timestampintegerObligatorio

  The UNIX timestamp for when the message will be sent, in UTC seconds.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• draft_idintegerObligatorio

  The ID of the draft you want to delete.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• message_idintegerObligatorio

  The target message's ID to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• queue_idstringObligatorio

  The ID of an event queue that was previously registered via POST /api/v1/register. This queue will be deleted and no longer available for event retrieval.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• reminder_idintegerObligatorio

  The ID of the reminder to delete. This is different from the unique ID that the message would have after being sent.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• saved_snippet_idintegerObligatorio

  The ID of the saved snippet to delete.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• scheduled_message_idintegerObligatorio

  The ID of the scheduled message to delete. This is different from the unique ID that the message would have after being sent.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• stream_idintegerObligatorio

  The ID of the channel/stream containing the topic to delete

• topic_namestringObligatorio

  The name of the topic to delete. Note: When the value of realm_empty_topic_display_name is used, it is interpreted as an empty string.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• draftobjectObligatorio

  Draft object containing the updated draft details.

• draft_idintegerObligatorio

  The ID of the draft to be edited.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The user-facing name for custom navigation views. Omit this field for built-in views. At least one of is_pinned or name must be provided.

• fragmentstringObligatorio

  The unique URL hash of the navigation view to be updated. This also serves as the identifier for the navigation view.

• is_pinnedboolean

  Determines whether the view is pinned (true) or hidden in the menu (false). At least one of is_pinned or name must be provided.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestring

  The title of the saved snippet.

• contentstring

  The content of the saved snippet in the original Zulip-flavored Markdown format. Clients should insert this content into a message when using a saved snippet.

• saved_snippet_idintegerObligatorio

  The ID of the saved snippet to edit.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• export_typestringenum

  Type of data export to create. 'public' exports only public data. 'full_with_consent' includes private data for users who have granted consent. 'full_without_consent' exports all data including private data for all users (requires organization to have owner_full_content_access feature enabled).

  publicfull_with_consentfull_without_consent

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_id_or_emailstringObligatorio

  The ID or Zulip API email address of the user whose presence you want to fetch. Accepts either user ID (integer as string) or email address. New in Zulip 4.0 (feature level 43) - previous versions only supported email.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• include_archivedboolean

  Whether to include archived channel folders in the response.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• queue_idstringObligatorio

  The ID of an event queue that was previously registered via POST /api/v1/register (see Register a queue).

• dont_blockboolean

  Set to true if the client is requesting a nonblocking reply. If not specified, the request will block until either a new event is available or a few minutes have passed, in which case the server will send the client a heartbeat event.

• last_event_idintegerObligatorio

  The highest event ID in this queue that you've received and wish to acknowledge. Use -1 to start from the beginning.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filenamestringObligatorio

  Path to the uploaded file. This is the path returned when uploading a file to Zulip.

• realm_id_strintegerObligatorio

  The ID of the Zulip organization.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idintegerObligatorio

  The target user's ID.

• user_group_idintegerObligatorio

  The ID of the target user group.

• direct_member_onlyboolean

  Whether to consider only the direct members of user group and not members of its subgroups. Default is `false`.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• message_idintegerObligatorio

  The target message's ID.

• apply_markdownboolean

  If true, message content is returned in rendered HTML format. If false, message content is returned in raw Zulip-flavored Markdown format. Defaults to true.

• allow_empty_topic_nameboolean

  Whether the client supports processing the empty string as a topic in the topic name fields. If false, the server uses realm_empty_topic_display_name instead. Defaults to false.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• message_idintegerObligatorio

  The target message's ID.

• allow_empty_topic_nameboolean

  Whether the topic names i.e. `topic` and `prev_topic` fields in the `message_history` objects returned can be empty string. If false, the value of `realm_empty_topic_display_name` found in the `POST /register` response is returned replacing the empty string as the topic name. Defaults to false. New in Zulip 10.0 (feature level 334).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• anchorstring

  Integer message ID to anchor fetching of new messages, or special string values: 'newest' (most recent message), 'oldest' (oldest message), 'first_unread' (oldest unread message matching query), or 'date' (first message on/after anchor_date). String values added in Zulip 3.0.

• narrowstring

  JSON-encoded narrow filter to restrict messages. For example, to fetch from all public channels: '{"operator": "channels", "operand": "public"}'. Many narrows search the user's personal message history. See Zulip documentation for constructing narrows.

• num_afterinteger

  Number of messages with IDs greater than the anchor to retrieve. Required if message_ids is not provided.

• num_beforeinteger

  Number of messages with IDs less than the anchor to retrieve. Required if message_ids is not provided.

• anchor_datestring

  Date or datetime to use when anchor is 'date'. Accepts ISO 8601 date-only (2005-04-18) or full datetime strings (2005-04-18T12:34:56Z). If only date, time is midnight UTC. New in Zulip 12.0 (feature level 445).

• message_idsstring

  JSON-encoded list of message IDs to fetch. Server returns messages from this list that exist and user has access to, optionally filtered by narrow. Mutually exclusive with anchor, include_anchor, use_first_unread_anchor, num_before, and num_after. New in Zulip 10.0 (feature level 300).

• apply_markdownboolean

  If true, message content is returned in rendered HTML format. If false, returns raw Markdown-format text that user entered.

• include_anchorboolean

  Whether a message with the specified ID matching the narrow should be included. New in Zulip 6.0 (feature level 155).

• client_gravatarboolean

  Whether the client supports computing gravatar URLs. If true, avatar_url is only included when there's a Zulip avatar (null for gravatar users). Default changed to true in Zulip 5.0 (feature level 92).

• allow_empty_topic_nameboolean

  Whether the client supports processing empty string as a topic name. If false, server uses realm_empty_topic_display_name instead. New in Zulip 10.0 (feature level 334).

• use_first_unread_anchorboolean

  Legacy way to specify anchor='first_unread' (Zulip 2.1.x and older). Whether to use the first unread message matching the narrow as anchor. Mutually exclusive with anchor. Deprecated in Zulip 3.0 (feature level 1).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• message_idintegerObligatorio

  The target message's ID to retrieve read receipts for.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• stream_idintegerObligatorio

  The ID of the channel to access.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• sender_idinteger

  The ID of a user or bot which should appear as the sender when messages are sent to the channel using the returned channel email address. Can be the ID of the current user, the Email gateway bot (default), or a bot owned by the current user.

• stream_idintegerObligatorio

  The ID of the channel to access.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• streamstringObligatorio

  The name of the channel to access. Channel names are case-sensitive in Zulip.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• include_allboolean

  Include all channels that the user has metadata access to. For organization administrators, this will be all channels in the organization. New in Zulip 10.0 (feature level 356). Defaults to false.

• include_publicboolean

  Include all public channels. Defaults to true.

• include_defaultboolean

  Include all default channels for the user's realm. When true, the is_default field will be present in stream objects. Defaults to false.

• exclude_archivedboolean

  Whether to exclude archived streams from the results. New in Zulip 10.0 (feature level 315). Defaults to true.

• include_all_activeboolean

  Deprecated parameter to include all channels. The user must have administrative privileges to use this parameter. Deprecated in Zulip 10.0 (feature level 356). Use include_all instead. Defaults to false.

• include_subscribedboolean

  Include all channels that the user is subscribed to. Defaults to true.

• include_web_publicboolean

  Include all web-public channels. Defaults to false.

• include_owner_subscribedboolean

  If the user is a bot, include all channels that the bot's owner is subscribed to. Defaults to false.

• include_can_access_contentboolean

  Include all the channels that the user has content access to. New in Zulip 10.0 (feature level 356). Defaults to false.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• stream_idintegerObligatorio

  The ID of the channel to access.

• allow_empty_topic_nameboolean

  Whether the client supports processing the empty string as a topic name in the returned data. If false, the value of realm_empty_topic_display_name found in the POST /register response is returned replacing the empty string as the topic name. New in Zulip 10.0 (feature level 334).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• stream_idintegerObligatorio

  The ID of the channel to access. This identifies which channel's subscribers you want to retrieve.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• include_subscribersstringenum

  Options for including subscriber information in channel objects.

  truefalsepartial

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idintegerObligatorio

  The target user's ID.

• stream_idintegerObligatorio

  The ID of the channel to access.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  The email address of the user to fetch. Two forms are supported: 1) The real email address of the user (delivery_email) - lookup succeeds if email visibility permits. 2) The dummy Zulip API email address of the form user{user_id}@{realm_host} (legacy behavior).

• client_gravatarboolean

  Whether the client supports computing gravatars URLs. If enabled, avatar_url will be included in the response only if there is a Zulip avatar, and will be null for users who are using gravatar as their avatar. Defaults to true.

• include_custom_profile_fieldsboolean

  Whether the client wants custom profile field data to be included in the response. New in Zulip 2.1.0. Defaults to false.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idintegerObligatorio

  The target user's ID.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_group_idintegerObligatorio

  The ID of the target user group.

• direct_member_onlyboolean

  Whether to consider only the direct members of user group and not members of its subgroups. Default is `false`.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• include_deactivated_groupsboolean

  Whether to include deactivated user groups in the response. Default is false. Available since Zulip 10.0 (feature level 290).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_group_idintegerObligatorio

  The ID of the target user group.

• direct_subgroup_onlyboolean

  Whether to consider only direct subgroups of the user group or subgroups of subgroups also. Default is `false`.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idintegerObligatorio

  The target user's ID.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• stream_idintegerObligatorio

  The ID of the channel (stream) to mark as read. All unread messages in this channel will be marked as read.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• stream_idintegerObligatorio

  The ID of the channel/stream containing the topic.

• topic_namestringObligatorio

  The name of the topic whose messages should be marked as read. Note: When the value of realm_empty_topic_display_name is used, it is interpreted as an empty string.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• opstringObligatorioenum

  Whether to mute ('add') or unmute ('remove') the provided topic.

  addremove
• topicstringObligatorio

  The topic to (un)mute. The request will succeed regardless of whether any messages have been sent to the specified topic.

• streamstring

  The name of the channel to access. Clients must provide either 'stream' or 'stream_id', but not both. Use 'stream_id' when possible for better performance.

• stream_idinteger

  The ID of the channel to access. Clients must provide either 'stream' or 'stream_id', but not both. Prefer this over 'stream' parameter.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idintegerObligatorio

  The target user's ID to reactivate.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• push_keystringObligatorio

  Key that the client would like the server to use to encrypt notifications, encoded with Base64. The key is a byte sequence beginning with a single byte that encodes which cryptosystem to use, followed by the key to use for that cryptosystem. Supported cryptosystems: 0x31 (LibSodium's SecretBox symmetric key encryption system). Keys are 32 bytes.

• token_kindstringObligatorioenum

  Whether the token was generated by FCM (Firebase Cloud Messaging) or APNs (Apple Push Notification service).

  fcmapns
• push_account_idintegerObligatorio

  A random integer generated by the client that will be included in mobile push notifications along with encrypted payloads to identify pushes as being related to this registration. Must be unique in the client's table of accounts.

• bouncer_public_keystringObligatorio

  Which of the bouncer's public keys the client used to encrypt the PushRegistration dictionary. When the bouncer rotates the key, a new asymmetric key pair is created, and the new public key is baked into a new client release. This field clarifies which public key the client is using.

• encrypted_push_registrationstringObligatorio

  Ciphertext generated by encrypting a PushRegistration dictionary using the bouncer_public_key, encoded using a RFC 4648 standard base64 encoder. The PushRegistration dictionary contains the fields token, token_kind, timestamp, and (for iOS devices) ios_app_id. The dictionary is JSON-encoded before encryption.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• narrowarray[]

  A JSON-encoded array of arrays of length 2 indicating the narrow filter(s) for which you'd like to receive events for. For example, to receive events for direct messages: [["is", "dm"]].

• event_typesstring[]

  A JSON-encoded array indicating which types of events you're interested in. Values that you might find useful include: 'message' (messages), 'subscription' (changes in your subscriptions), 'realm_user' (changes to users in the organization and their properties). If you do not specify this parameter, you will receive all events.

• slim_presenceboolean

  If true, the presences object returned in the response will be keyed by user ID and the entry for each user's presence data will be in the modern format.

• apply_markdownboolean

  Set to true if you would like the content to be rendered in HTML format (otherwise the API will return the raw text that the user entered).

• client_gravatarboolean

  Whether the client supports computing gravatar URLs. If enabled, avatar_url will be included in the response only if there is a Zulip avatar, and will be null for users who are using gravatar as their avatar.

• fetch_event_typesstring[]

  Same as the event_types parameter except that the values in fetch_event_types are used to fetch initial data. If fetch_event_types is not provided, event_types is used.

• all_public_streamsboolean

  Whether you would like to request message events from all public channels. Useful for workflow bots that you'd like to see all new messages sent to public channels.

• client_capabilitiesobject

  Dictionary containing details on features the client supports that are relevant to the format of responses sent by the server.

• include_subscribersstring

  Whether each returned channel object should include a subscribers field containing a list of the user IDs of its subscribers. Supported values: 'true', 'false', 'partial'. The 'partial' value returns subset of subscribers for some channels.

• presence_history_limit_daysinteger

  Limits how far back in time to fetch user presence data. If not specified, defaults to 14 days. A value of N means that the oldest presence data fetched will be from at most N days ago.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• alert_wordsstring[]Obligatorio

  An array of strings to be removed from the user's set of configured alert words. Strings that are not in the user's set of alert words are ignored.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• attachment_idintegerObligatorio

  The ID of the attachment to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• playground_idintegerObligatorio

  The ID of the playground that you want to remove.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• stream_idintegerObligatorio

  The ID of the target channel to remove from default streams. This will stop the channel from being automatically subscribed to new users in the organization.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tokenstringObligatorio

  The FCM registration token provided by the device to be removed.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filter_idintegerObligatorio

  The ID of the linkifier that you want to remove.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• fragmentstringObligatorio

  The unique URL hash of the navigation view to be removed. This also serves as the identifier for the navigation view.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emoji_codestring

  A unique identifier defining the specific emoji codepoint within the namespace of the reaction_type. Optional for most cases, but important when removing a vote on an existing reaction to ensure correct interpretation, especially when handling emoji data mapping changes.

• emoji_namestring

  The target emoji's human-readable name (e.g., 'octopus', 'smile', 'thumbs_up'). To find an emoji's name, hover over a message to reveal reaction options.

• message_idintegerObligatorio

  The target message's ID to remove the reaction from.

• reaction_typestring

  Type of emoji namespace. Supported values: 'unicode_emoji' (dash-separated hex Unicode codepoints), 'realm_emoji' (custom emoji ID), 'zulip_extra_emoji' (special Zulip emoji). Should match the value used when the reaction was originally added.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• contentstringObligatorio

  The content of the message to render. This should be in Zulip's Markdown format. Clients should use the max_message_length returned by the POST /register endpoint to determine the maximum message size.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orderinteger[]Obligatorio

  A list of channel folder IDs representing the new order. This list must include the IDs of all the organization's channel folders, including archived folders. The order in which the IDs appear in this list determines the new display order of the folders.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orderinteger[]Obligatorio

  A list of the IDs of all the custom profile fields defined in this organization, in the desired new order. This list must include all custom profile field IDs currently configured in the realm.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ordered_linkifier_idsinteger[]Obligatorio

  A list of the IDs of all the linkifiers defined in this organization, in the desired new order. This list must include all linkifier IDs currently configured in the realm.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• invite_idintegerObligatorio

  The ID of the email invitation to be revoked.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• invite_idintegerObligatorio

  The ID of the reusable invitation link to be revoked.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• toanyObligatorio

  For channel messages: channel name (string) or channel ID (integer). For direct messages: list of user IDs (integers) or list of email addresses (strings). Examples: 'general' for channel name, 42 for channel ID, [123, 456] for user IDs, ['user@example.com'] for email addresses.

• typestringObligatorioenum

  The type of message to be sent. 'direct' for a direct message and 'stream' or 'channel' for a channel message. Note: 'private' is deprecated, use 'direct' instead.

  directchannelstreamprivate
• topicstring

  The topic of the message. Required for channel messages (type='stream' or type='channel'), ignored for direct messages. Clients should use the max_topic_length returned by the POST /register endpoint to determine the maximum topic length.

• contentstringObligatorio

  The content of the message in Zulip's Markdown format. Clients should use the max_message_length returned by the POST /register endpoint to determine the maximum message size.

• local_idstring

  For clients supporting local echo, a unique string-format identifier chosen freely by the client. The server will pass it back without inspection. Required if queue_id is provided.

• queue_idstring

  For clients supporting local echo, the event queue ID for the client. If passed, local_id is required. Used to avoid message duplication on reconnection.

• read_by_senderboolean

  Whether the message should be initially marked read by its sender. If unspecified, the server uses a heuristic based on the client name.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tokenstring

  The push token for the device to which to send the test notification. If not provided, the test notification will be sent to all of the user's devices registered on the server. A mobile client should pass this parameter to avoid triggering a test notification for other clients.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• opstringObligatorioenum

  Whether the user has started ('start') or stopped ('stop') typing.

  startstop
• tointeger[]

  User IDs of the recipients of the message being typed. Required for the 'direct' type. Ignored in the case of 'stream' or 'channel' type. Clients should send a JSON-encoded list of user IDs, even if there is only one recipient.

• typestringenum

  Type of the message being composed. 'direct' for direct messages, 'stream' or 'channel' for channel messages. Defaults to 'direct'.

  directstreamchannel
• topicstring

  Topic to which message is being typed. Required for the 'stream' or 'channel' type. Ignored in the case of 'direct' type. Note: When '(no topic)' is used for this parameter, it is interpreted as an empty string.

• stream_idinteger

  ID of the channel in which the message is being typed. Required for the 'stream' or 'channel' type. Ignored in the case of 'direct' type.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• opstringObligatorioenum

  Whether the user has started ('start') or stopped ('stop') editing.

  startstop
• message_idintegerObligatorio

  The target message's ID.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• announceboolean

  If one of the channels specified did not exist previously and is thus created by this call, this determines whether the notification bot will send an announcement about the new channel's creation. Defaults to false.

• principalsarray

  A list of user IDs (preferred) or Zulip API email addresses of the users to be subscribed to the specified channels. If not provided, the requesting user/bot is subscribed. User IDs (integers) are preferred over email addresses (strings).

• invite_onlyboolean

  Whether any newly created channels will be private channels. Private channels require an invitation to join. Only applies when creating new channels. Defaults to false (public channel).

• is_web_publicboolean

  Whether any newly created channels will be web-public, meaning anyone can read messages without being logged in. Note that creating web-public channels requires specific server and organization settings. Only applies when creating new channels. Defaults to false.

• subscriptionsobject[]Obligatorio

  A list of channel subscription objects. Each object must contain a 'name' field specifying the channel name, and can optionally contain a 'description' field for creating new channels.

• authorization_errors_fatalboolean

  Whether authorization errors (such as when the requesting user is not authorized to access a private channel) should be considered fatal. When true (default), an authorization error is reported as an error. When false, the response will be a 200 and any channels where the request encountered an authorization error will be listed in the 'unauthorized' key.

• history_public_to_subscribersboolean

  Whether the channel's message history should be available to newly subscribed members. If true, new subscribers can see all past messages. If false, users can only see messages sent after they subscribed. This is relevant for private channels and only applies when creating new channels.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• welcome_message_custom_textstringObligatorio

  Custom message text, in Zulip Markdown format, to be used for this test message. Maximum length is 8000 characters.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• principalsarray

  A list of user IDs (preferred) or Zulip API email addresses of the users to be unsubscribed from the channels specified in the `subscriptions` parameter. If not provided, then the requesting user/bot is unsubscribed. The integer format is new in Zulip 3.0 (feature level 9).

• subscriptionsstring[]Obligatorio

  A list of channel names to unsubscribe from. Each name should be the exact name of the channel as it appears in Zulip.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The new name of the channel folder. Value cannot be an empty string. Clients should use the max_channel_folder_name_length returned by the POST /register endpoint to determine the maximum channel folder name length.

• descriptionstring

  The new description of the channel folder. Clients should use the max_channel_folder_description_length returned by the POST /register endpoint to determine the maximum channel folder description length.

• is_archivedboolean

  Whether to archive or unarchive the channel folder.

• channel_folder_idintegerObligatorio

  The ID of the target channel folder to update.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• patternstringObligatorio

  The Python regular expression that should trigger the linkifier. Use named groups (e.g., (?P<id>[0-9]+)) to capture parts of the match that can be used in the URL template.

• filter_idintegerObligatorio

  The ID of the linkifier that you want to update.

• url_templatestringObligatorio

  The RFC 6570 compliant URL template used for the link. Insert content from named groups in the pattern using {name_of_group}. This replaced url_format_string in Zulip 7.0 (feature level 176).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• topicstring

  The topic to move the message(s) to, to request changing the topic. Should only be sent when changing the topic, and will throw an error if the target message is not a channel message. You can resolve topics by editing the topic to '✔ {original_topic}' with propagate_mode set to 'change_all'.

• contentstring

  The updated content of the target message. Clients should use the max_message_length returned by the POST /register endpoint to determine the maximum message size. Note that a message's content and channel cannot be changed at the same time, so sending both content and stream_id parameters will throw an error.

• stream_idinteger

  The channel ID to move the message(s) to, to request moving messages to another channel. Should only be sent when changing the channel, and will throw an error if the target message is not a channel message. Note that a message's content and channel cannot be changed at the same time, so sending both content and stream_id parameters will throw an error.

• message_idintegerObligatorio

  The target message's ID to be updated.

• propagate_modestringenum

  Propagate mode for message updates.

  change_onechange_laterchange_all
• prev_content_sha256string

  An optional SHA-256 hash of the previous raw content of the message that the client has at the time of the request. If provided, the server will return an error if it does not match the SHA-256 hash of the message's content stored in the database. Clients can use this feature to prevent races where multiple clients save conflicting edits to a message.

• send_notification_to_new_threadboolean

  Whether to send an automated message to the new topic to notify users where the messages came from. If the move is just resolving/unresolving a topic, this parameter will not trigger an additional notification. Defaults to true.

• send_notification_to_old_threadboolean

  Whether to send an automated message to the old topic to notify users where the messages were moved to. Defaults to false.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• opstringObligatorioenum

  Whether to add the flag or remove it from the specified messages.

  addremove
• flagstringObligatorio

  The flag that should be added/removed. Common flags include 'read', 'starred', 'collapsed', 'mentioned', 'wildcard_mentioned', 'has_alert_word', 'historical'.

• messagesinteger[]Obligatorio

  An array containing the IDs of the target messages to update flags for.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• opstringObligatorioenum

  Whether to add the flag or remove it.

  addremove
• flagstringObligatorio

  The flag that should be added/removed. Common flags include 'read', 'starred', 'collapsed', 'mentioned', 'wildcard_mentioned', 'has_alert_word', 'historical'.

• anchoranyObligatorio

  Integer message ID to anchor the update range, or special string values: 'newest' (most recent message), 'oldest' (oldest message), 'first_unread' (oldest unread message).

• narrowobject[]

  List of narrow filter objects defining the search criteria. See Zulip's narrow documentation for supported operators. When adding the 'read' flag, consider including the 'is:unread' filter for optimization.

• num_afterintegerObligatorio

  Limit the number of messages following the anchor in the update range. The server may decrease this to bound transaction sizes.

• num_beforeintegerObligatorio

  Limit the number of messages preceding the anchor in the update range. The server may decrease this to bound transaction sizes.

• include_anchorboolean

  Whether a message with the specified ID matching the narrow should be included in the update range.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emojisetstring

  The user's configured emoji set, used to display emoji to the user everywhere they appear in the UI. Valid values: 'google', 'twitter', 'text'.

• enter_sendsboolean

  Whether pressing Enter in the compose box sends a message (or saves a message edit).

• color_schemestringenum

  Controls which color theme to use.

  AutomaticDark themeLight theme
• enable_soundsboolean

  Enable audible desktop notifications for direct messages and @-mentions.

• web_home_viewstring

  The home view used when opening a new Zulip web app window or hitting the Esc keyboard shortcut repeatedly. Valid values: 'recent', 'inbox', 'all_messages'.

• user_list_stylestringenum

  The style selected by the user for the right sidebar user list.

  CompactWith statusWith avatar and status
• hide_ai_featuresboolean

  Controls whether user wants AI features like topic summarization to be hidden in all Zulip clients.

• presence_enabledboolean

  Display the presence status to other users when online.

• web_font_size_pxinteger

  User-configured primary font-size for the web application, in pixels.

• fluid_layout_widthboolean

  Whether to use the maximum available screen width for the web app's center panel (message feed, recent conversations) on wide screens.

• high_contrast_modeboolean

  This setting is reserved for use to control variations in Zulip's design to help visually impaired users.

• left_side_userlistboolean

  Whether the users list on left sidebar in narrow windows.

• notification_soundstring

  Notification sound name.

• send_read_receiptsboolean

  Whether other users are allowed to see whether you've read messages.

• translate_emoticonsboolean

  Whether to translate emoticons to emoji in messages the user sends.

• enable_digest_emailsboolean

  Enable digest emails when the user is away.

• twenty_four_hour_timeboolean

  Whether time should be displayed in 24-hour notation.

• starred_message_countsboolean

  Whether clients should display the number of starred messages.

• demote_inactive_streamsstringenum

  Whether to hide inactive channels in the left sidebar.

  AutomaticAlwaysNever
• web_line_height_percentinteger

  User-configured primary line-height for the web application, in percent, so a value of 120 represents a line-height of 1.2.

• email_address_visibilitystringenum

  Policy for which other users can see the user's real email address.

  EveryoneMembers onlyAdministrators onlyNobodyModerators only
• web_channel_default_viewstringenum

  Default navigation behavior when clicking on a channel link.

  Top topic in the channelChannel feedList of topicsTop unread topic in channel
• wildcard_mentions_notifyboolean

  Whether wildcard mentions (E.g. @**all**) should send notifications like a personal mention.

• desktop_icon_count_displaystringenum

  Unread count badge (appears in desktop sidebar and browser tab).

  All unread messagesDMs, mentions, and followed topicsDMs and mentionsNone
• web_animate_image_previewsstringenum

  Controls how animated images should be played in the message feed.

  alwayson_hovernever
• web_suggest_update_timezoneboolean

  Whether the user should be shown an alert, offering to update their profile time zone, when the time displayed for the profile time zone differs from the current time displayed by the time zone configured on their device.

• display_emoji_reaction_usersboolean

  Whether to display the names of reacting users on a message. When enabled, clients should display the names of reacting users for messages with few total reactions.

• enable_desktop_notificationsboolean

  Enable visual desktop notifications for direct messages and @-mentions.

• web_navigate_to_sent_messageboolean

  Web/desktop app setting for whether the user's view should automatically go to the conversation where they sent a message.

• enable_drafts_synchronizationboolean

  A boolean parameter to control whether synchronizing drafts is enabled for the user. When synchronization is disabled, all drafts stored in the server will be automatically deleted from the server.

• receives_typing_notificationsboolean

  Whether the user is configured to receive typing notifications from other users. The server will only deliver typing notifications events to users who for whom this is enabled.

• web_inbox_show_channel_foldersboolean

  Determines whether channel folders are used to organize how conversations with unread messages are displayed in the web/desktop application's Inbox view.

• web_mark_read_on_scroll_policystringenum

  Whether or not to mark messages as read when the user scrolls through their feed.

  AlwaysOnly in conversation viewsNever
• enable_online_push_notificationsboolean

  Enable mobile notification for direct messages and @-mentions received when the user is online.

• enable_stream_push_notificationsboolean

  Enable mobile notifications for channel messages.

• send_stream_typing_notificationsboolean

  Whether typing notifications be sent when composing channel messages.

• enable_offline_push_notificationsboolean

  Enable mobile notification for direct messages and @-mentions received when the user is offline.

• enable_stream_email_notificationsboolean

  Enable email notifications for channel messages.

• send_private_typing_notificationsboolean

  Whether typing notifications be sent when composing direct messages.

• web_escape_navigates_to_home_viewboolean

  Whether the escape key navigates to the configured home view.

• automatically_follow_topics_policystringenum

  Which topics to follow automatically.

  Topics the user participates inTopics the user sends a message toTopics the user startsNever
• enable_offline_email_notificationsboolean

  Enable email notifications for direct messages and @-mentions received when the user is offline.

• enable_stream_audible_notificationsboolean

  Enable audible desktop notifications for channel messages.

• enable_stream_desktop_notificationsboolean

  Enable visual desktop notifications for channel messages.

• pm_content_in_desktop_notificationsboolean

  Include content of direct messages in desktop notifications.

• web_left_sidebar_show_channel_foldersboolean

  Determines whether channel folders are used to organize how channels are displayed in the web/desktop application's left sidebar.

• message_content_in_email_notificationsboolean

  Include the message's content in email notifications for new messages.

• resolved_topic_notice_auto_read_policystringenum

  Controls whether the resolved-topic notices are marked as read.

  alwaysexcept_followednever
• web_left_sidebar_unreads_count_summaryboolean

  Determines whether the web/desktop application's left sidebar displays the unread message count summary.

• web_stream_unreads_count_display_policystringenum

  Configuration for which channels should be displayed with a numeric unread count.

  All channelsUnmuted channels and topicsNo channels
• enable_followed_topic_push_notificationsboolean

  Enable push notifications for messages sent to followed topics.

• realm_name_in_email_notifications_policystringenum

  Whether to include organization name in subject of message notification emails.

  AutomaticAlwaysNever
• enable_followed_topic_email_notificationsboolean

  Enable email notifications for messages sent to followed topics.

• automatically_follow_topics_where_mentionedboolean

  Whether the server will automatically mark the user as following topics where the user is mentioned.

• email_notifications_batching_period_secondsinteger

  The duration (in seconds) for which the server should wait to batch email notifications before sending them.

• enable_followed_topic_audible_notificationsboolean

  Enable audible desktop notifications for messages sent to followed topics.

• enable_followed_topic_desktop_notificationsboolean

  Enable visual desktop notifications for messages sent to followed topics.

• enable_followed_topic_wildcard_mentions_notifyboolean

  Whether wildcard mentions (e.g., @**all**) in messages sent to followed topics should send notifications like a personal mention.

• automatically_unmute_topics_in_muted_streams_policystringenum

  Which topics to unmute automatically in muted channels.

  Topics the user participates inTopics the user sends a message toTopics the user startsNever

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• toany

  The scheduled message's tentative target audience. For channel messages, the integer ID of the channel. For direct messages, a list containing integer user IDs. Required when updating the type of the scheduled message.

• typestringenum

  Type of message to send.

  directchannelstreamprivate
• topicstring

  The updated topic of the scheduled message. Required when updating the type of the scheduled message to "stream" or "channel". Ignored when the existing or updated type of the scheduled message is "direct" (or "private"). Clients should use the max_topic_length returned by the POST /register endpoint to determine the maximum topic length. Note: When "(no topic)" or the value of realm_empty_topic_display_name found in the POST /register response is used for this parameter, it is interpreted as an empty string. When topics are required, this parameter can't be "(no topic)", an empty string, or the value of realm_empty_topic_display_name.

• contentstring

  The updated content of the scheduled message. Clients should use the max_message_length returned by the POST /register endpoint to determine the maximum message size.

• scheduled_message_idintegerObligatorio

  The ID of the scheduled message to update. This is different from the unique ID that the message would have after being sent.

• scheduled_delivery_timestampinteger

  The UNIX timestamp for when the message will be sent, in UTC seconds. Required when updating a scheduled message that the server has already tried and failed to send. This state is indicated with 'failed: true' in scheduled_messages objects; see response description at GET /scheduled_messages.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstring

  Asks the server to initiate a confirmation sequence to change the user's email address. User will need to click a confirmation link sent to the new address.

• emojisetstring

  The user's configured emoji set, used to display emoji everywhere in the UI. Options: 'google', 'twitter', 'text'.

• timezonestring

  The IANA identifier of the user's profile time zone, used primarily to display the user's local time to other users.

• full_namestring

  A new display name for the user.

• enter_sendsboolean

  Whether pressing Enter in the compose box sends a message (or saves a message edit).

• color_schemestringenum

  Color theme preference.

  AutomaticDark themeLight theme
• new_passwordstring

  The user's new password. The old_password parameter must be included in the request.

• old_passwordstring

  The user's old password. Required only when sending the new_password parameter.

• target_usersobject

  Specification for collection of users whose settings should be modified.

• enable_soundsboolean

  Enable audible desktop notifications for direct messages and @-mentions.

• web_home_viewstring

  The home view used when opening a new Zulip web app window or hitting the Esc keyboard shortcut repeatedly. Options: 'recent', 'inbox', 'all_messages'.

• user_list_stylestringenum

  Style for right sidebar user list.

  CompactWith statusWith avatar and status
• default_languagestring

  What default language to use for the account. This controls both the Zulip UI as well as email notifications. The value needs to be a standard language code like 'en' for English or 'de' for German.

• hide_ai_featuresboolean

  Controls whether user wants AI features like topic summarization to be hidden in all Zulip clients.

• presence_enabledboolean

  Display the presence status to other users when online.

• web_font_size_pxinteger

  User-configured primary font-size for the web application, in pixels.

• fluid_layout_widthboolean

  Whether to use the maximum available screen width for the web app's center panel on wide screens.

• high_contrast_modeboolean

  Reserved for use to control variations in Zulip's design to help visually impaired users.

• left_side_userlistboolean

  Whether the users list on left sidebar in narrow windows.

• notification_soundstring

  Notification sound name.

• send_read_receiptsboolean

  Whether other users are allowed to see whether you've read messages.

• enable_login_emailsboolean

  Enable email notifications for new logins to account.

• translate_emoticonsboolean

  Whether to translate emoticons to emoji in messages the user sends.

• enable_digest_emailsboolean

  Enable digest emails when the user is away.

• twenty_four_hour_timeboolean

  Whether time should be displayed in 24-hour notation.

• starred_message_countsboolean

  Whether clients should display the number of starred messages.

• demote_inactive_streamsstringenum

  Policy for hiding inactive channels in left sidebar.

  AutomaticAlwaysNever
• enable_marketing_emailsboolean

  Enable marketing emails. Has no function outside Zulip Cloud.

• web_line_height_percentinteger

  User-configured primary line-height for the web application, in percent (e.g., 120 represents a line-height of 1.2).

• email_address_visibilitystringenum

  Policy for who can see user's email address.

  EveryoneMembers onlyAdministrators onlyNobodyModerators only
• web_channel_default_viewstringenum

  Default navigation behavior when clicking channel links.

  Top topic in the channelChannel feedTop unread topic in channel
• wildcard_mentions_notifyboolean

  Whether wildcard mentions (e.g., @**all**) should send notifications like a personal mention.

• allow_private_data_exportboolean

  Whether organization administrators are allowed to export your private data.

• desktop_icon_count_displaystringenum

  Unread count badge display policy.

  All unread messagesDMs, mentions, and followed topicsDMs and mentionsNone
• web_animate_image_previewsstringenum

  How animated images should be played.

  alwayson_hovernever
• web_suggest_update_timezoneboolean

  Whether the user should be shown an alert offering to update their profile time zone when it differs from their device time zone.

• display_emoji_reaction_usersboolean

  Whether to display the names of reacting users on a message rather than a count.

• enable_desktop_notificationsboolean

  Enable visual desktop notifications for direct messages and @-mentions.

• web_navigate_to_sent_messageboolean

  Web/desktop app setting for whether the user's view should automatically go to the conversation where they sent a message.

• enable_drafts_synchronizationboolean

  Whether synchronizing drafts is enabled for the user. When disabled, all drafts stored in the server will be automatically deleted.

• receives_typing_notificationsboolean

  Whether the user is configured to receive typing notifications from other users.

• web_inbox_show_channel_foldersboolean

  Determines whether channel folders are used to organize how conversations with unread messages are displayed in the web/desktop application's Inbox view.

• web_mark_read_on_scroll_policystringenum

  Policy for marking messages as read on scroll.

  AlwaysOnly in conversation viewsNever
• enable_online_push_notificationsboolean

  Enable mobile notification for direct messages and @-mentions received when the user is online.

• enable_stream_push_notificationsboolean

  Enable mobile notifications for channel messages.

• send_stream_typing_notificationsboolean

  Whether typing notifications be sent when composing channel messages.

• enable_offline_push_notificationsboolean

  Enable mobile notification for direct messages and @-mentions received when the user is offline.

• enable_stream_email_notificationsboolean

  Enable email notifications for channel messages.

• send_private_typing_notificationsboolean

  Whether typing notifications be sent when composing direct messages.

• web_escape_navigates_to_home_viewboolean

  Whether the escape key navigates to the configured home view.

• automatically_follow_topics_policystringenum

  Policy for which topics to follow automatically.

  Topics the user participates inTopics the user sends a message toTopics the user startsNever
• enable_offline_email_notificationsboolean

  Enable email notifications for direct messages and @-mentions received when the user is offline.

• enable_stream_audible_notificationsboolean

  Enable audible desktop notifications for channel messages.

• enable_stream_desktop_notificationsboolean

  Enable visual desktop notifications for channel messages.

• pm_content_in_desktop_notificationsboolean

  Include content of direct messages in desktop notifications.

• web_left_sidebar_show_channel_foldersboolean

  Determines whether channel folders are used to organize how channels are displayed in the web/desktop application's left sidebar.

• message_content_in_email_notificationsboolean

  Include the message's content in email notifications for new messages.

• resolved_topic_notice_auto_read_policystringenum

  Policy for marking resolved-topic notices as read.

  alwaysexcept_followednever
• web_left_sidebar_unreads_count_summaryboolean

  Determines whether the web/desktop application's left sidebar displays the unread message count summary.

• web_stream_unreads_count_display_policystringenum

  Policy for displaying unread counts in left sidebar.

  All channelsUnmuted channels and topicsNo channels
• enable_followed_topic_push_notificationsboolean

  Enable push notifications for messages sent to followed topics.

• realm_name_in_email_notifications_policystringenum

  Policy for including organization name in email subjects.

  AutomaticAlwaysNever
• enable_followed_topic_email_notificationsboolean

  Enable email notifications for messages sent to followed topics.

• automatically_follow_topics_where_mentionedboolean

  Whether the server will automatically mark the user as following topics where the user is mentioned.

• email_notifications_batching_period_secondsinteger

  The duration (in seconds) for which the server should wait to batch email notifications before sending them.

• enable_followed_topic_audible_notificationsboolean

  Enable audible desktop notifications for messages sent to followed topics.

• enable_followed_topic_desktop_notificationsboolean

  Enable visual desktop notifications for messages sent to followed topics.

• enable_followed_topic_wildcard_mentions_notifyboolean

  Whether wildcard mentions (e.g., @**all**) in messages sent to followed topics should send notifications like a personal mention.

• automatically_unmute_topics_in_muted_streams_policystringenum

  Policy for which topics to follow automatically.

  Topics the user participates inTopics the user sends a message toTopics the user startsNever

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• awayboolean

  Whether the user should be marked as 'away'. Deprecated in Zulip 6.0 (feature level 148); starting with that feature level, away is a legacy way to access the user's presence_enabled setting, with away = !presence_enabled.

• emoji_codestring

  A unique identifier, defining the specific emoji codepoint requested, within the namespace of the reaction_type. Available in Zulip 5.0+ (feature level 86).

• emoji_namestring

  The name for the emoji to associate with this status. Available in Zulip 5.0+ (feature level 86).

• status_textstring

  The text content of the status message. Sending the empty string will clear the user's status. Maximum 60 characters.

• reaction_typestringenum

  Type of emoji reaction for status.

  unicode_emojirealm_emojizulip_extra_emoji

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idintegerObligatorio

  The target user's ID.

• emoji_codestring

  A unique identifier, defining the specific emoji codepoint requested, within the namespace of the `reaction_type`. Changes: New in Zulip 5.0 (feature level 86).

• emoji_namestring

  The name for the emoji to associate with this status. Changes: New in Zulip 5.0 (feature level 86).

• status_textstring

  The text content of the status message. Sending the empty string will clear the user's status. Note: The limit on the size of the message is 60 characters.

• reaction_typestring

  A string indicating the type of emoji. Each emoji `reaction_type` has an independent namespace for values of `emoji_code`. Must be one of: 'unicode_emoji' (dash-separated hex encoding of Unicode codepoints), 'realm_emoji' (ID of uploaded custom emoji), or 'zulip_extra_emoji' (special Zulip emoji name). Changes: New in Zulip 5.0 (feature level 86).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• new_namestring

  The new name for the channel. Clients should use the max_stream_name_length returned by the POST /register endpoint to determine the maximum channel name length.

• folder_idinteger

  ID of the new channel folder to which the channel should belong. A null value indicates the user wants to remove the channel from its current channel folder.

• stream_idintegerObligatorio

  The ID of the channel to update.

• is_privateboolean

  Change whether the channel is a private channel.

• descriptionstring

  The new description for the channel, in Zulip-flavored Markdown format. Clients should use the max_stream_description_length returned by the POST /register endpoint to determine the maximum channel description length.

• is_archivedboolean

  A boolean indicating whether the channel is archived or unarchived. Currently only allows unarchiving previously archived channels.

• is_web_publicboolean

  Change whether the channel is a web-public channel. Note that creating web-public channels requires the WEB_PUBLIC_STREAMS_ENABLED server setting to be enabled on the Zulip server, the organization to have enabled the enable_spectator_access realm setting, and the current user to have permission under the organization's can_create_web_public_channel_group realm setting.

• topics_policystringenum

  Policy for how topics work in the channel.

  inheritallow_empty_topicdisable_empty_topicempty_topic_only
• is_default_streamboolean

  Add or remove the channel as a default channel for new users joining the organization.

• can_subscribe_groupobject

  Model for updating permission group settings with new and optional old values.

• can_create_topic_groupobject

  Model for updating permission group settings with new and optional old values.

• can_send_message_groupobject

  Model for updating permission group settings with new and optional old values.

• message_retention_daysany

  Number of days that messages sent to this channel will be stored before being automatically deleted by the message retention policy. Special values: 'realm_default' (return to organization-level setting), 'unlimited' (retain messages forever). Can also be an integer for specific number of days.

• can_resolve_topics_groupobject

  Model for updating permission group settings with new and optional old values.

• can_add_subscribers_groupobject

  Model for updating permission group settings with new and optional old values.

• can_administer_channel_groupobject

  Model for updating permission group settings with new and optional old values.

• can_delete_any_message_groupobject

  Model for updating permission group settings with new and optional old values.

• can_delete_own_message_groupobject

  Model for updating permission group settings with new and optional old values.

• can_remove_subscribers_groupobject

  Model for updating permission group settings with new and optional old values.

• history_public_to_subscribersboolean

  Whether the channel's message history should be available to newly subscribed members, or users can only access messages they actually received while subscribed to the channel. It's an error for this parameter to be false for a public or web-public channel. This can only be false if can_create_topic_group for the channel is the role:everyone system group.

• can_move_messages_out_of_channel_groupobject

  Model for updating permission group settings with new and optional old values.

• can_move_messages_within_channel_groupobject

  Model for updating permission group settings with new and optional old values.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• addobject[]

  A list of objects describing which channels to subscribe to, optionally including per-user subscription parameters (e.g. color) and if the channel is to be created, its description.

• deletestring[]

  A list of channel names to unsubscribe from.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• subscription_dataobject[]Obligatorio

  A list of objects that describe the changes that should be applied in each subscription. Each object represents a subscription, and must have a 'stream_id' key that identifies the channel, as well as the 'property' being modified and its new 'value'.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• rolestringenum

  User role enum for Zulip organizational hierarchy.

  owneradministratormoderatormemberguest
• emailstringObligatorio

  The email address of the user to update, specified following the same rules as GET /users/{email}. Supports both real email addresses and dummy Zulip API email addresses.

• full_namestring

  The user's full name. Use this to update the display name of the user.

• new_emailstring

  New email address for the user. Requires the user making the request to be an organization owner and additionally have the .can_change_user_emails special permission. Available in Zulip 10.0+ (feature level 285).

• profile_dataobject[]

  A list of custom profile field updates. Each entry contains the field ID and the new value for that field.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• topicstringObligatorio

  The topic for which the personal preferences need to be updated. The request will succeed regardless of whether any messages have been sent to the specified topic.

• stream_idintegerObligatorio

  The ID of the channel to access.

• visibility_policystringObligatorioenum

  Controls which visibility policy to set. 'none' (0) removes the visibility policy previously set for the topic. 'muted' (1) mutes the topic in a channel. 'unmuted' (2) unmutes the topic in a muted channel. 'followed' (3) follows the topic. In an unmuted channel, a topic visibility policy of unmuted will have the same effect as the 'none' visibility policy.

  nonemutedunmutedfollowed

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not