Supportpal icon

Supportpal

Consume Supportpal REST API (v.1.2.4)

Actions22

User → Update

AI-generated

Overview

This node interacts with the Supportpal REST API to update user information. It allows updating various user fields such as first name, last name, email, password, phone, country, language code, timezone, confirmation status, active status, organisation details, group memberships, and custom fields. This operation is useful for managing user profiles in a Supportpal system, for example, updating contact details or changing user status.

Use Case Examples

  1. Updating a user's email and phone number after they have changed their contact information.
  2. Setting a user's account to inactive when they leave the organization.
  3. Adding a user to a new organisation or changing their access level within an organisation.

Properties

Name Meaning
ID The ID of the user to update.
Simplify Response Return a simplified response containing only the user data.
Additional Fields Optional fields of the user to update, such as first name, last name, email, password, phone, country, language code, timezone, confirmation status, active status, organisation details, organisation access level, organisation notifications, and groups.
Custom Fields Custom fields to set specific values for the user.

Output

JSON

  • id - The unique identifier of the updated user.
  • firstname - The first name of the user.
  • lastname - The last name of the user.
  • email - The email address of the user.
  • phone - The phone number of the user.
  • country - The country code of the user.
  • language_code - The language code of the user.
  • timezone - The timezone of the user.
  • confirmed - Whether the user has confirmed their email.
  • active - Whether the user account is active.
  • organisation - The organisation the user belongs to.
  • organisation_id - The ID of the organisation the user belongs to.
  • organisation_access_level - The access level of the user in the organisation.
  • organisation_notifications - Whether the user receives organisation notifications.
  • groups - The groups the user belongs to.
  • customfield - Custom fields set for the user.

Dependencies

  • Supportpal REST API

Troubleshooting

  • Ensure the user ID provided exists; otherwise, the update will fail with a 'not found' error.
  • If setting 'confirmed' to true, a password must be provided; otherwise, the API may reject the update.
  • Check that the organisation ID exists if assigning the user to an existing organisation.
  • Custom fields must be valid and exist in the Supportpal system; invalid custom field IDs will cause errors.
  • API authentication credentials must be correctly configured to avoid authorization errors.

Links

Discussion