3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Update User" operation in the Users resource allows you to modify the details of an existing user within the 3CX telephony system. This node is useful for automating user management tasks such as updating contact information, changing permissions, enabling or disabling features like voicemail or call recording, and adjusting user-specific telephony settings.

Practical examples include:

  • Automatically updating a user's phone number or email address when their profile changes.
  • Enabling or disabling two-factor authentication (2FA) for enhanced security.
  • Adjusting call forwarding profiles or office hours based on organizational policies.
  • Managing voicemail settings or transcription preferences programmatically.

This operation helps maintain up-to-date user configurations without manual intervention in the 3CX management console.

Properties

Name Meaning
Id The unique identifier of the user entity to update. Can be set dynamically using expressions like {{$json.Id}}.
Access Password Password used for access control.
Allow Lan Only Boolean flag to restrict user access to LAN only.
Allow Own Recordings Boolean indicating if the user can access their own call recordings.
Auth ID Authentication ID for the user.
Auth Password Authentication password for the user.
Blfs String representing BLF (Busy Lamp Field) keys configuration.
Break Time JSON object defining break periods for the user.
Call Screening Boolean to enable or disable call screening feature.
Call Us Enable Chat Boolean to enable chat in the "Call Us" feature.
Call Us Enable Phone Boolean to enable phone calls in the "Call Us" feature.
Call Us Enable Video Boolean to enable video calls in the "Call Us" feature.
Call Us Requirement Option to specify required fields for "Call Us" (Both, Name, Email, None).
Click To Call Id Identifier for click-to-call functionality.
Contact Image URL or string representing the user's contact image.
Current Profile Name Name of the current profile assigned to the user.
Deskphone Password Password for deskphone device.
Display Name User's display name.
Email Address User's email address.
Emergency Additional Info Additional emergency information for the user.
Emergency Location Id Identifier for the user's emergency location.
Enable 2 FA Boolean to enable two-factor authentication for the user.
Enabled Boolean to enable or disable the user account.
Enable Hotdesking Boolean to enable hotdesking feature for the user.
First Name User's first name.
Forwarding Exceptions JSON array defining exceptions to call forwarding rules.
Forwarding Profiles JSON array defining call forwarding profiles and routes.
Google Calendar Enabled Boolean to enable Google Calendar integration.
Google Contacts Enabled Boolean to enable Google Contacts integration.
Google Sign In Enabled Boolean to enable Google sign-in for the user.
Greetings JSON array defining greeting messages or prompts.
Groups JSON array defining groups the user belongs to, including rights and tags.
Hide In Phonebook Boolean to hide the user from the phonebook.
Hotdesking Assignment String specifying hotdesking assignment details.
Hours JSON object defining working hours or availability periods.
Internal Boolean indicating if the user is internal.
Is Registered Boolean indicating if the user is currently registered.
Language User's preferred language.
Last Name User's last name.
Mobile User's mobile phone number.
MS 365 Calendar Enabled Boolean to enable Microsoft 365 Calendar integration.
MS 365 Contacts Enabled Boolean to enable Microsoft 365 Contacts integration.
MS 365 Sign In Enabled Boolean to enable Microsoft 365 sign-in for the user.
MS 365 Teams Enabled Boolean to enable Microsoft Teams integration.
My Phone Allow Delete Recordings Boolean to allow deleting recordings via My Phone app.
My Phone Hide Forwardings Boolean to hide forwarding options in My Phone app.
My Phone Push Boolean to enable push notifications in My Phone app.
My Phone Show Recordings Boolean to show recordings in My Phone app.
Number User's phone number.
Office Hours Props JSON array defining office hours properties.
Outbound Caller ID Outbound caller ID number or name.
Pbx Delivers Audio Boolean indicating if PBX delivers audio directly.
Phones JSON array defining phone devices and their settings associated with the user.
Pin Protected Boolean indicating if the user is pin protected.
Pin Protect Timeout Number specifying timeout duration for pin protection.
Primary Group Id Numeric ID of the user's primary group.
Prompt Set String specifying the prompt set used by the user.
Queue Status Option indicating queue status: Logged Out or Logged In.
Record Calls Boolean to enable call recording.
Record Email Notify Boolean to enable email notifications for recorded calls.
Record External Calls Only Boolean to record only external calls.
Require 2 FA Boolean to require two-factor authentication.
Send Email Missed Calls Boolean to send email notifications for missed calls.
SIPID SIP identifier for the user.
SRTP Mode Option for Secure RTP mode: Disabled, Enabled, or Enforced.
Tags JSON array of tags associated with the user.
Transcription Mode Option for transcription mode: Nothing, Voicemail, Recordings, Both, or Inherit.
VM Disable Pin Auth Boolean to disable PIN authentication for voicemail.
VM Email Options Option for voicemail email handling: None, Notification, Attachment, Attachment And Delete.
VM Enabled Boolean to enable voicemail.
VMPIN PIN code for voicemail access.
VM Play Caller ID Boolean to play caller ID in voicemail.
VM Play Msg Date Time Option to play message date/time in voicemail: None, Play 12 Hr, Play 24 Hr.
Web Meeting Approve Participants Boolean to require approval for web meeting participants.
Web Meeting Friendly Name Friendly name for web meetings.

Output

The node outputs the response from the 3CX API after updating the user. The output is structured as JSON data containing the updated user details or confirmation of the update operation. This typically includes all user properties reflecting the new state after the update.

No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to a 3CX telephony system API endpoint.
  • Requires an API authentication token or OAuth2 credentials configured in n8n to authorize requests.
  • The base URL for the 3CX server must be provided in the credentials.
  • The node sends HTTP requests with JSON payloads to the 3CX API.

Troubleshooting

  • Invalid or missing user Id: Ensure the "Id" property is correctly set and corresponds to an existing user in 3CX.
  • Authentication errors: Verify that the API credentials are valid and have sufficient permissions to update users.
  • Malformed JSON inputs: For properties expecting JSON (e.g., BreakTime, ForwardingProfiles), ensure the JSON syntax is correct.
  • API connectivity issues: Confirm network access to the 3CX server and that the base URL is correctly configured.
  • Permission denied errors: Check that the authenticated user has rights to modify user settings.
  • Unexpected field values: Validate that option fields (e.g., CallUsRequirement, SRTPMode) use allowed values.

Links and References

Discussion