Numi Profile icon

Numi Profile

Numi Profile Node
Join our community

Overview

The Numi Profile node allows you to interact with user profiles in the Numi system. It supports two main operations: retrieving an existing user profile by a unique identifier (typically a phone number), and setting or updating a user's profile information, including personal details and metadata.

Common scenarios:

  • Fetching a user's profile data for use in downstream automation.
  • Creating or updating user profiles with new information, such as contact details or custom metadata.
  • Integrating Numi user management into automated workflows, e.g., onboarding, CRM updates, or personalized messaging.

Practical examples:

  • Retrieve a user's profile before sending them a notification.
  • Update a user's email and add custom metadata after they complete a form.
  • Store additional structured data (as JSON) in a user's profile for advanced segmentation.

Properties

Name Meaning
Operation Selects the action to perform:
- Get: Get a profile
- Set: Set a profile
User Unique Identifier The unique identifier of 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 Key-value pairs to add as metadata to the profile. Each entry has a "Name" and a "Value". Used when "Set" is selected.
Metadata JSON Key-JSON pairs to add as structured metadata to the profile. Each entry has a "Name" and a "JSON" value. Used when "Set" is selected.

Output

For "Get" Operation

  • The output will include a numi_profile field in the json object:
    • exists: Boolean indicating if the profile was found.
    • profile: The retrieved profile object (structure depends on Numi's API).

Example:

{
  "numi_profile": {
    "exists": true,
    "profile": {
      // ...profile fields from Numi...
    }
  }
}

For "Set" Operation

  • The output will be the input data, potentially updated, but no explicit confirmation or new fields are added to the output structure.

Dependencies

  • External Service: Requires access to the Numi API.
  • API Key: You must configure credentials named numiKeyApi in n8n.
  • n8n Configuration: Ensure the credential is set up in your n8n instance.

Troubleshooting

  • Missing or Invalid Credentials:
    If the required numiKeyApi credential is not configured or invalid, the node will fail to connect to the Numi service.
  • Invalid User Unique Identifier:
    If the provided identifier does not match any user, the exists field will be false and profile may be empty.
  • Malformed Metadata JSON:
    If you provide invalid JSON in the "Metadata JSON" property, the node will log an error and skip that metadata entry. Ensure all JSON values are valid.
  • Required Fields Missing:
    For the "Get" operation, "User Unique Identifier" is required. For "Set", at least one profile field should be provided.

Links and References

Discussion