Actions35
- Profile Actions
- Passport Actions
- Punch Pass Actions
- Participant Actions
- List Actions
Overview
This node operation creates a new Punch Pass for a specified profile in the OneTap system. A Punch Pass is typically used to manage and track a limited number of check-ins or visits associated with a user profile, such as loyalty cards or membership passes.
Common scenarios where this node is beneficial include:
- Creating loyalty punch cards for customers (e.g., "Coffee Loyalty Card" allowing 10 visits).
- Issuing time-limited access passes that expire after a certain date.
- Managing attendance or usage limits for events, classes, or services.
Practical example:
- A coffee shop wants to issue a punch pass to a customer profile that allows 10 free coffees within 6 months. The node creates this pass with a start date, optional expiration date, and check-in limit.
Properties
| Name | Meaning |
|---|---|
| Profile ID | The unique identifier of the profile for which the punch pass will be created. |
| Starts At | The start date and time when the punch pass becomes valid. |
| Create Fields | Additional optional fields to define the punch pass: |
| - Name | Name of the punch pass (e.g., "Coffee Loyalty Card"). |
| - Expires At | Expiration date and time of the punch pass (optional). |
| - Check Ins Limit | Maximum number of check-ins allowed on the punch pass (must be a positive integer). |
Output
The output JSON contains the newly created punch pass object returned by the OneTap API. This includes details such as:
- The punch pass ID.
- Associated profile ID.
- Start and expiration timestamps.
- Name of the punch pass.
- Check-in limit.
- Current status and metadata related to the punch pass.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the OneTap API service.
- Requires an API authentication credential configured in n8n to authorize requests.
- The node uses the OneTap API base URL
https://api-beta.onetapcheckin.com. - Proper permissions to create punch passes for profiles in the OneTap account are necessary.
Troubleshooting
- Invalid Profile ID: If the provided Profile ID does not exist or is incorrect, the API will return an error. Verify the Profile ID before running the node.
- Date Format Issues: The
Starts AtandExpires Atfields must be valid date-time values. Invalid dates may cause request failures. - Check Ins Limit Validation: The check-ins limit must be a positive integer (minimum 1). Providing invalid numbers may result in errors.
- API Authentication Errors: Ensure the API key or token credential is correctly set up and has sufficient permissions.
- Network or API Downtime: Temporary network issues or OneTap API downtime can cause request failures. Retry later or check service status.
Common error messages usually indicate invalid input parameters or authentication failures. Review the error message details and adjust inputs accordingly.
Links and References
- OneTap API Documentation (for detailed API endpoints and data models)
- n8n HTTP Request Node Documentation (for understanding HTTP request handling in n8n)
If you need further details about other operations or resources, feel free to ask!