Numi Profile

Numi Profile Node

Overview

The Numi Profile node allows you to either retrieve ("Get") or update ("Set") a user's profile in the Numi system. It is typically used in workflows where you need to fetch user details by their unique identifier (usually a phone number), or update user information such as name, email, phone, date of birth, and custom metadata.

Common scenarios:

Fetching a user's profile for validation or enrichment before proceeding with other workflow steps.
Updating user profiles with new information collected from forms, integrations, or other sources.
Storing additional metadata about users, including both simple key-value pairs and structured JSON data.

Practical examples:

Retrieve a user's profile based on their phone number to check if they exist in the system.
Update a user's email and add custom metadata after they complete a registration form.

Properties

Name	Meaning
Operation	Selects the action to perform: - Get: Get a profile - Set: Set a profile
User Unique Identifier	The unique identifier for the user (for Numi, this is the phone number). Required when using "Get".
First Name	The user's first name to set in the profile. Used when "Set" is selected.
Last Name	The user's last name to set in the profile. Used when "Set" is selected.
Email	The user's email address to set in the profile. Used when "Set" is selected.
Phone Number	The user's phone number to set in the profile. Used when "Set" is selected.
Date of Birth	The user's date of birth (format: YYYY-MM-DD) to set in the profile. Used when "Set" is selected.
Metadata	Add custom metadata as key-value pairs to the profile. Multiple entries allowed. Used when "Set" is selected.
Metadata JSON	Add custom metadata as key-JSON pairs to the profile. Each entry consists of a name and a JSON value. Multiple entries allowed. Used with "Set".

Output

For Get operation:

The output will include a numi_profile field in the json object:

{
  "numi_profile": {
    "exists": true, // or false
    "profile": { ... } // profile object if exists, otherwise null/undefined
  }
}

For Set operation:
- The output will be the same as the input, with no additional fields added to the json object.

Note: This node does not output binary data.

Dependencies

External Service: Requires access to the Numi API via a partner service.
Credentials: You must configure the numiKeyApi credential in n8n for authentication.

Troubleshooting

Missing or Invalid Credentials:
If the required numiKeyApi credential is not configured or is invalid, the node will fail to connect to the Numi API. Ensure credentials are set up correctly in n8n.
Invalid User Unique Identifier:
When performing a "Get" operation, if the provided user identifier (phone number) is missing or incorrect, the node may return a profile with "exists": false.
Invalid Metadata JSON:
If you provide malformed JSON in the "Metadata JSON" property, the node will log an error and skip that metadata entry. Make sure your JSON values are valid.
Date Format Issues:
The "Date of Birth" should be in YYYY-MM-DD format. Incorrect formats may result in errors or unexpected behavior.

Links and References

n8n Documentation: Credentials
n8n Documentation: Nodes
JSON Validator Tool (for validating Metadata JSON values)

Numi ProfileInstall