CodeQR icon

CodeQR

Consume CodeQR API

Actions8

Overview

This node integrates with the CodeQR API to update existing short links. It allows users to modify various attributes of a short link such as its destination URL, expiration date, device-specific URLs, appearance settings, and tracking options. This is useful in scenarios where you need to dynamically change the behavior or metadata of a short link without creating a new one, for example updating marketing campaign URLs, changing redirection targets based on new promotions, or managing link expiration.

Practical examples:

  • Updating the destination URL of a short link after a product launch.
  • Setting an expiration date for a limited-time offer link.
  • Adding geo-targeting rules to redirect users from different countries to localized pages.
  • Changing the QR code appearance or enabling/disabling public statistics.

Properties

Name Meaning
Authentication Method of authentication; currently supports "Access Token".
Link ID The unique identifier of the short link to update (required).
Update Fields Collection of fields to update on the short link:
- Allow Indexing Enable or disable indexing of the short link by search engines.
- Android URL Destination URL for Android devices.
- Comments Notes or comments about the short link.
- Description Description shown on the short link page.
- Domain Domain used for the short link; defaults to workspace domain if not specified.
- Expiration Date Date/time when the short link expires.
- Expired Redirect URL URL to redirect users when the short link has expired.
- External ID Custom external identifier for the link, must be prefixed with "ext_".
- Flexible Link Whether the link supports dynamic destination setting.
- Geo-Targeting JSON mapping of country codes to destination URLs for geographic redirection.
- Image URL URL of an image displayed on the short link page.
- iOS URL Destination URL for iOS devices.
- Long URL The main destination URL of the short link.
- Password Password required to access the destination URL.
- Proxy Enable proxy settings for the link.
- Public Stats Make the short link's statistics publicly accessible.
- Rewrite Link Enable link rewriting.
- Tag IDs Array of tag IDs to apply to the short link.
- Tag Names Array of tag names to apply to the short link.
- Title Title displayed on the short link page.
- Video URL URL of a video displayed on the short link page.
Update Fields (QR Code) Additional collection of fields related to QR Code customization:
- Background Color Background color of the QR Code.
- Description Description associated with the QR Code.
- Email Email data for email-based QR Codes (JSON format).
- Expiration Date Expiration date of the QR Code.
- Foreground Color Foreground color of the QR Code.
- Image URL URL of an image associated with the QR Code.
- Phone Phone number stored in the QR Code.
- Public Stats Whether QR Code stats are publicly accessible.
- Show Logo Whether to display a logo in the QR Code.
- Size Size of the QR Code in pixels (default 300).
- Static/Dynamic Whether the QR Code is static (fixed content) or dynamic (editable content).
- Text Text content stored in the QR Code.
- Title Title associated with the QR Code.
- Track Conversion Enable conversion tracking for the QR Code.
- URL Destination URL of the QR Code.

Output

The node outputs a JSON array containing the updated short link object returned by the CodeQR API. This object includes all the current properties of the short link after the update, such as its ID, URLs, metadata, expiration, tags, and QR code settings if applicable.

If the node handles binary data (e.g., QR code images), it would typically include this in the binary output field, but based on the provided information, the primary output is JSON data representing the updated link.

Dependencies

  • Requires an active connection to the CodeQR API.
  • Needs an API key credential (access token) configured in n8n for authentication.
  • Network access to the CodeQR service endpoint.

Troubleshooting

  • Missing or invalid Link ID: The node requires a valid short link ID to update. Ensure the ID is correct and exists in your CodeQR account.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Invalid field values: Some fields like URLs must be valid URLs; JSON fields (e.g., geo-targeting) must be properly formatted JSON strings.
  • Expired or revoked API key: If updates fail due to authorization, check the status of your API key.
  • Unsupported operation error: If the node throws an error about unsupported operations, ensure you selected the correct resource ("Link") and operation ("Update").
  • Network issues: Timeouts or connectivity problems can cause failures; verify network access to the CodeQR API.

Links and References

Discussion