Beaconstac

These are the Beaconstac actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Create Place

  Tool to create a new place for location-based assets. Use when you need to register a new physical place under an organization.

• Create QR Template

  Creates a new QR Code template with customizable design attributes. QR Code templates allow you to define reusable design presets for QR codes in your organization. You can customize colors, patterns, shapes, gradients, logos, frames, and more. Once created, templates can be applied to multiple QR codes for consistent branding. Use this when you need to: - Create branded QR code designs for your organization - Set up reusable design presets for QR code campaigns - Define custom styling including colors, patterns, logos, and frames

• Create Tag

  Tool to create a new tag for organizing QR Codes and other objects. Use when you need to categorize QR Codes under a specific organization.

• Create User

  Tool to create a new User. Use when onboarding a new user under your organization (Reseller plan and above).

• Delete QR Code

  Tool to delete a QR Code by its ID. Use when you need to remove an existing QR Code after validation.

• Delete QR Code Template

  Tool to delete a QR Code template by its ID. Use when you need to permanently remove a QR Code template that is no longer needed.

• Delete Tag

  Tool to delete a tag by its ID. Use when you need to remove an existing Tag after validation.

• Get Period Overview

  Tool to get period overview analytics for products including counts, impressions, and conversion percentage. Use after specifying the product_type and time interval.

• Get Product Overview

  Tool to get analytics overview for a specified product type over a given time interval. Use after specifying the product type and time range to obtain summary metrics.

• List Bulk QR Code Collections

  Tool to list Bulk QR Code collections. Use when you need to filter, search, or order your bulk QR Code collections.

• List Organizations

  List all organizations accessible to the authenticated account. Use this tool when you need to: - Get a list of all organizations the user has access to - Retrieve organization details including IDs, names, and configuration - Access organization feature permissions and account limits - Check subscription status and owner information The response includes comprehensive organization data with pagination support.

• List Places

  Tool to list your Places. Use when you need to browse or search your account's Places with filtering and ordering.

• List QR Templates

  Tool to list all QR code templates in your account. Use when you need to filter and paginate templates.

• List Tags

  Tool to list all tags with optional filtering and pagination. Use when you need to browse or search tags in your account.

• List Users

  Tool to list all users with optional filtering, searching, ordering, and pagination. Use when you need to retrieve user records across your organization.

• Retrieve QR Code

  Retrieve detailed information about a specific QR Code by its ID. Returns QR code properties including name, type (static/dynamic), short URL, encoded data, design attributes, scan count, organization, and timestamps. Use this when you need to fetch, verify, or inspect QR Code details after creation or update.

• Retrieve User

  Tool to retrieve the details of an existing User by ID. Use when you need to fetch a user's profile after confirming its existence.

• Update Place

  Tool to update the specified Place by ID. Use after retrieving the Place to modify its details, such as name, address, or coordinates.

• Update QR Code

  Update an existing QR Code by its ID. Modify QR Code properties like name, design attributes, tags, and content. Returns the complete updated QR Code object. Important: When updating qr_type, you must also provide the corresponding content: - For static QR codes (qr_type=1): Include fields_data with qr_type and content (e.g., url) - For dynamic QR codes (qr_type=2): Include campaign with content_type and custom_url

• Update Tag

  Tool to update an existing tag by its ID. Use when you need to modify a tag's name or color after confirming its ID via list_tags.

• Update User

  Tool to update an existing User. Use when you need to modify profile details or organization of a User by their ID.