3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Update My User" operation in the 3CX node allows you to modify the settings and profile information of the currently authenticated user within the 3CX telephony system. This operation is useful for administrators or users who want to programmatically update their personal preferences, security settings, call handling rules, and other user-specific configurations.

Common scenarios include:

  • Updating user contact details such as email, phone number, or display name.
  • Changing security settings like enabling/disabling two-factor authentication or updating passwords.
  • Configuring call forwarding profiles, call screening, and voicemail options.
  • Managing integration settings with external services like Google Calendar or Microsoft 365.
  • Adjusting user availability, office hours, and queue status.

Practical example:

  • Automatically update a user's voicemail preferences and forwarding rules based on changes in an HR system.
  • Enable or disable features like call recording or chat availability dynamically via workflow automation.

Properties

Name Meaning
Access Password The password used for accessing the user account.
Allow Lan Only Whether the user is restricted to LAN-only access.
Allow Own Recordings Permission for the user to access their own call recordings.
Auth ID Authentication identifier for the user.
Auth Password Authentication password for the user.
Blfs Busy Lamp Field settings (monitoring other extensions).
Break Time JSON object defining break periods for the user.
Call Screening Enables or disables call screening feature.
Call Us Enable Chat Enables chat functionality for incoming calls.
Call Us Enable Phone Enables phone functionality for incoming calls.
Call Us Enable Video Enables video functionality for incoming calls.
Call Us Requirement Requirement for caller information: Both, Name, Email, or None.
Click To Call Id Identifier used for click-to-call functionality.
Contact Image URL or identifier for the user's contact image.
Current Profile Name Name of the current user profile.
Deskphone Password Password for deskphone authentication.
Display Name User's display name.
Email Address User's email address.
Emergency Additional Info Additional emergency information.
Emergency Location Id Identifier for the emergency location associated with the user.
Enable 2 FA Enables two-factor authentication for the user.
Enabled Whether the user account is enabled.
Enable Hotdesking Enables 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 Enables Google Calendar integration.
Google Contacts Enabled Enables Google Contacts integration.
Google Sign In Enabled Enables Google sign-in for the user.
Greetings JSON array defining greeting messages/settings.
Groups JSON array defining groups the user belongs to, including rights and tags.
Hide In Phonebook Whether to hide the user from the phonebook.
Hotdesking Assignment Assignment details for hotdesking.
Hours JSON object defining working hours or availability periods.
Id Numeric identifier of the user.
Internal Whether the user is internal to the organization.
Is Registered Indicates if the user is currently registered (e.g., logged into the system).
Language Preferred language of the user.
Last Name User's last name.
Mobile User's mobile phone number.
MS 365 Calendar Enabled Enables Microsoft 365 Calendar integration.
MS 365 Contacts Enabled Enables Microsoft 365 Contacts integration.
MS 365 Sign In Enabled Enables Microsoft 365 sign-in for the user.
MS 365 Teams Enabled Enables Microsoft Teams integration.
My Phone Allow Delete Recordings Allows the user to delete their own phone recordings.
My Phone Hide Forwardings Hides forwarding settings in the user's phone interface.
My Phone Push Enables push notifications to the user's phone.
My Phone Show Recordings Shows call recordings in the user's phone interface.
Number User's phone number or extension.
Office Hours Props JSON array defining office hours properties.
Outbound Caller ID Caller ID used for outbound calls.
Pbx Delivers Audio Whether the PBX delivers audio directly.
Phones JSON array defining phone devices and their settings associated with the user.
Pin Protected Whether the user is protected by a PIN.
Pin Protect Timeout Timeout duration for PIN protection.
Primary Group Id Numeric identifier of the user's primary group.
Prompt Set Name of the prompt set used for the user.
Queue Status User's queue status: Logged In or Logged Out.
Record Calls Enables call recording for the user.
Record Email Notify Enables email notifications for recorded calls.
Record External Calls Only Records only external calls.
Require 2 FA Requires two-factor authentication for the user.
Send Email Missed Calls Sends email notifications for missed calls.
SIPID SIP identifier for the user.
SRTP Mode Secure RTP mode: Disabled, Enabled, or Enforced.
Tags JSON array of tags associated with the user.
Transcription Mode Voicemail/recording transcription mode: Nothing, Voicemail, Recordings, Both, or Inherit.
VM Disable Pin Auth Disables PIN authentication for voicemail.
VM Email Options Voicemail email options: None, Notification, Attachment, or Attachment And Delete.
VM Enabled Enables voicemail for the user.
VMPIN Voicemail PIN code.
VM Play Caller ID Plays caller ID during voicemail playback.
VM Play Msg Date Time Plays message date/time during voicemail playback: None, 12 Hr, or 24 Hr format.
Web Meeting Approve Participants Requires approval for participants joining web meetings.
Web Meeting Friendly Name Friendly name for web meetings.

Output

The output of this operation is a JSON object representing the updated user profile as returned by the 3CX API. It typically includes all the fields that were sent for update along with any additional metadata or status information provided by the server.

No binary data output is indicated for 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 API must be configured in the node credentials.
  • The node sends HTTP requests with JSON payloads to the 3CX API.

Troubleshooting

  • Invalid Credentials: If authentication fails, verify that the API key or OAuth2 credentials are correctly configured and have sufficient permissions.
  • Malformed JSON Input: Properties expecting JSON input (e.g., BreakTime, ForwardingProfiles) must be valid JSON strings; otherwise, parsing errors will occur.
  • Missing Required Fields: Some updates may require mandatory fields like Id or DisplayName. Ensure these are provided.
  • API Endpoint Issues: Confirm the 3CX server URL is correct and accessible from the n8n environment.
  • Permission Denied: The authenticated user might lack permission to update certain fields; check user roles and privileges in 3CX.
  • Data Validation Errors: Invalid values for enumerated options (e.g., SRTPMode, QueueStatus) will cause errors; use allowed option values.

Links and References

Discussion