paywise icon

paywise

Consume paywise API
Join our community

Actions20

Overview

This node integrates with the Partner API to create a new user within a specified company. It supports two input methods for user creation: either by filling out individual form fields or by providing a complete JSON object representing the user data.

Typical use cases include automating user onboarding processes in a partner system, where new users need to be registered programmatically with their email, name, company association, and notification preferences. For example, when a new employee joins a company, this node can be used to create their user account automatically, optionally skipping email verification if already handled elsewhere.

Properties

Name Meaning
Input Method Method to use for user creation. Options:
- Form Fields: Configure user using individual form fields.
- JSON: Provide full user data as a JSON object.
User JSON (Shown if Input Method is JSON) The complete user data as a JSON object. Must include at minimum: email, first_name, last_name, and company (UUID). Can also include optional fields like skip_email_verification and notification_channels. Example provided in the property hint.
Email (Required if Input Method is Form Fields) Email address of the user.
First Name (Required if Input Method is Form Fields) First name of the user.
Last Name (Required if Input Method is Form Fields) Last name of the user.
Company ID (Required if Input Method is Form Fields) UUID of the company that the user will belong to.
Additional Fields (Optional, shown if Input Method is Form Fields) Collection of additional options:
- Skip Email Verification: Boolean flag indicating if the user's email should be considered verified without confirmation. Use only if email is validated externally.
Notification Channels (Optional, shown if Input Method is Form Fields) One or more notification channels to configure for the user. Each channel includes:
- Channel Type (currently only "Email" supported)
- Value (email address for notifications)
- Notification Types (e.g., Status Updates, Requests to Client, Statements)

Output

The node outputs an array of JSON objects, each representing the created user as returned by the Partner API. The exact structure depends on the API response but typically includes user details such as user ID, email, name, company association, and notification settings.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential configured in n8n to authenticate with the Partner API.
  • The node relies on the Partner API being accessible and properly configured to accept user creation requests.
  • Proper permissions are needed on the API key to create users within the specified company.

Troubleshooting

  • Missing Required Fields: If required fields like email, first name, last name, or company ID are missing, the API will likely reject the request. Ensure all mandatory fields are provided.
  • Invalid Company UUID: Providing an incorrect or non-existent company UUID will cause the API to fail user creation. Verify the company ID beforehand.
  • Email Verification Skipped Improperly: Using the skip email verification option without prior validation may lead to unverified or invalid emails in the system.
  • Notification Channels Misconfiguration: Only "Email" channel type is supported currently. Using unsupported types or malformed notification types may cause errors.
  • API Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • JSON Input Errors: When using the JSON input method, ensure the JSON is well-formed and includes all required fields.

Common error messages usually relate to validation failures from the API, such as missing fields or unauthorized access. Reviewing the API response message will help identify the exact issue.

Links and References

{
  "email": "user@example.com",
  "first_name": "Max",
  "last_name": "Mustermann",
  "company": "6196ba03-83f2-46ea-83e1-a087bd0c5acc",
  "skip_email_verification": true,
  "notification_channels": [
    {
      "channel_type": "EMAIL",
      "value": "user@example.com",
      "notification_types": ["STATUS_UPDATE", "REQUESTS_TO_CLIENT", "STATEMENTS"]
    }
  ]
}

Discussion