Actions53
- Channel Actions
- Direct Message Actions
- Message Actions
- User Actions
User → Create
AI-generatedSummary
Creates a new Rocket.Chat user account with specified credentials and attributes.
Inputs
- name (required) — The display name of the user.
- email (required) — The email address of the user.
- username (required) — The username of the user.
- password (required) — The password for the user.
- additionalFields.active — Whether the user account is active (default: true).
- additionalFields.joinDefaultChannels — Whether the user joins default channels (default: true).
- additionalFields.requirePasswordChange — Whether the user must change their password on first login (default: false).
- additionalFields.roles — Comma-separated list of roles assigned to the user (default: 'user').
- additionalFields.sendWelcomeEmail — Whether a welcome email is sent to the user (default: false).
- additionalFields.verified — Whether the user is verified (default: false).
Output shape
A single user record containing the created account details.
Returns the raw API response object from Rocket.Chat.
Examples
Example 1: Create a standard user account with default settings.
Sets name, email, username, and password. Leaves 'active' and 'joinDefaultChannels' as defaults.
Example 2: Create a user requiring a password change and with specific roles.
Sets password change requirement to true and assigns 'admin' and 'moderator' roles.