OneTap icon

OneTap

Manage visitors, check-ins, and attendance with OneTap
Join our community

Actions35

Overview

This node integrates with the OneTap API to manage visitor profiles, including updating profile information. Specifically, the Profile - Update operation allows users to modify details of an existing visitor profile by specifying the profile ID and the fields to update. This is useful in scenarios where visitor information changes over time, such as updating contact details, notes, or custom attributes.

Practical examples:

  • Updating a visitor's phone number or email after they provide new contact info.
  • Marking a profile as a favorite for quick access.
  • Adding or modifying custom fields like employee IDs or membership status.
  • Changing the check-in code associated with a profile.

Properties

Name Meaning
Profile ID The unique identifier of the profile to update (required).
Update Fields Collection of fields to update on the profile. Options include:
- Name: Full name of the profile (string).
- Email: Valid email address (string).
- Phone: Phone number (digits only, auto-formatted) (string).
- Address: Physical address (string).
- Notes: Additional notes about the profile (string).
- Favorite: Boolean flag to mark profile as favorite.
- Check-in Code: Unique alphanumeric check-in code (string).
- Custom Fields: Multiple custom field entries, each with:
- Field Name (string)
- Field Type (one of String, Number, Boolean, Date, Array)
- Field Value (string, parsed according to type)

Output

The output is a JSON object representing the updated profile data returned from the OneTap API. It contains all the profile fields after the update, including any modified standard or custom fields.

Example structure (simplified):

{
  "id": "profile-id",
  "name": "Updated Name",
  "email": "updated@example.com",
  "phone": "1234567890",
  "address": "123 Main St, City, State",
  "notes": "VIP member",
  "favorite": true,
  "checkInCode": "JD001",
  "customFields": {
    "employeeId": "EMP001",
    "someBooleanField": true,
    "someDateField": 1680000000
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the OneTap API.
  • The node makes HTTP requests to https://api-beta.onetapcheckin.com/api/profiles/{profileId} using PUT method.
  • Proper configuration of the OneTap API credentials in n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Profile ID will cause the update to fail.
    • Providing invalid email format in the email field may result in API validation errors.
    • Incorrectly formatted custom field values (e.g., invalid date strings) might cause parsing errors.
    • Network or authentication failures if API key is incorrect or expired.

  • Error messages:

    • "Failed to execute profile operation from OneTap API: <error message>" indicates an issue during the API call.
    • Validation errors from the API typically specify which field is invalid.

  • Resolutions:

    • Ensure the Profile ID exists and is correct.
    • Validate email addresses before sending.
    • Format dates properly; the node converts date strings to Unix timestamps.
    • Confirm API credentials are valid and have required permissions.
    • Use the "Continue On Fail" option in the node settings to handle errors gracefully in workflows.

Links and References

This summary covers the logic and usage of the OneTap node's Profile Update operation based on static analysis of the source code and provided property definitions.

Discussion