企业微信(WeCom)-连接微信Install

Summary

Update the configuration for how customers join group chats in WeCom by specifying the configuration ID, scenes, and chat group IDs, optionally updating settings such as remarks, automatic group creation, channel state, and customer source marking.

Inputs

• config_id (required) — The unique identifier of the join group chat configuration to update.
• scene (required) — Specifies the type of join method: 1 for group mini-program plugin, 2 for group QR code plugin.
• chat_id_list (required) — List of group chat IDs to associate with this configuration, overwriting existing ones; supports comma, pipe, or newline separators, and must include 1 to 5 groups.
• updateRemark — A boolean flag to enable updating the remark field; when enabled, the provided remark will overwrite the original, an empty string clears it.
• remark — The remark text up to 30 characters, sent only if updateRemark is true.
• updateAutoCreateRoom — A boolean flag to enable updating the auto-create room setting.
• auto_create_room — When auto-create room is enabled and updateAutoCreateRoom is true, specifies if a new group is auto-created when the existing group is full.
• customRoomNaming — When enabled with auto_create_room, allows custom group naming by specifying prefix and starting number.
• room_base_name — The prefix name for auto-created groups, up to 40 characters, required if customRoomNaming is true.
• room_base_id — The starting sequence number for auto-created groups; integer >= 1.
• updateState — A boolean to enable updating the channel state parameter; if enabled, the state string replaces the existing or clears it if empty.
• state — Custom state string up to 30 UTF-8 characters, sent only if updateState is true.
• updateMarkSource — Enable updating the customer source marking, effective only for marketing acquisition applications and only by the creating application.
• mark_source — When mark source update is enabled, determines if the customer addition source is marked as this application-created join group configuration.

Output shape

a single JSON object representing the updated join way configuration result from the WeCom API

The operation requires valid application permissions configured for '客户联系 - 可调用接口的应用' or use of a secret credential tied to '客户联系'. The scene and chat IDs are mandatory and will overwrite the original settings; other optional fields are updated only if their corresponding update switches are enabled. An error object may be returned in case of failure.

Examples

Example 1: Update join method with new group list and remarks

Set 'config_id' to the target configuration, 'scene' to 2 (group QR code plugin), provide new 'chat_id_list', enable 'updateRemark' with new 'remark' text, optionally update other flags to change settings like automatic group creation or state.

Links

• n8n community nodes installation guide