Supportpal icon

Supportpal

Consume Supportpal REST API (v.1.2.4)

Actions22

User → Create

AI-generated

Overview

This node interacts with the Supportpal REST API to create a new user. It allows setting the user's email (required) and various optional fields such as brand ID, first name, last name, password, phone, country, language code, timezone, confirmation status, active status, organisation details, group memberships, and custom fields. This node is useful for automating user registration and management workflows in Supportpal, such as adding new users with specific attributes or associating them with organisations and groups.

Use Case Examples

  1. Automatically create a new user in Supportpal when a new customer signs up on a website, including setting their email, name, and organisation.
  2. Batch import users into Supportpal with custom fields and group memberships from an external database or CRM system.

Properties

Name Meaning
Email The email address of the user to be created.
Simplify Response Whether to return a simplified response containing only the user data.
Additional Fields Optional additional fields for the user such as brand ID, first name, last name, password, phone, country, language code, timezone, confirmation status, active status, organisation details, organisation access level, organisation notifications, and groups the user belongs to.
Custom Fields Custom fields to set specific values for the user; supports multiple custom fields identified by field ID and value.

Output

JSON

  • id - The unique identifier of the created user.
  • email - The email address of the created user.
  • firstname - The first name of the created user.
  • lastname - The last name of the created user.
  • active - Indicates if the user account is active.
  • confirmed - Indicates if the user has confirmed their email ownership.
  • organisation_id - The organisation ID the user belongs to, if any.
  • groups - List of group IDs the user belongs to.
  • customfield - Custom field values set for the user.

Dependencies

  • Supportpal REST API

Troubleshooting

  • Ensure the API credentials for Supportpal are correctly configured and have permissions to create users.
  • Verify that the required 'email' field is provided and correctly formatted.
  • If setting 'confirmed' to true, ensure a password is also provided, as it is required for confirmation.
  • Check that any organisation IDs or group IDs provided exist in the Supportpal system.
  • If the API returns errors, review the error message for details such as invalid fields or permission issues and adjust the input accordingly.

Links

Discussion