Skip to main content
Beaconstac logo
  • Category: marketing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 21
  • Triggers: 0
  • Slug: BEACONSTAC
  • Version: 20261101_00

Tools

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

Input Parameters

string
required
Name of the place.
string
required
Physical address of the place.
string
required
Latitude coordinate of the place.
string
required
Longitude coordinate of the place.
integer
required
ID of the organization this place belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_CREATE_QR_TEMPLATECreates 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

Input Parameters

object
Arbitrary metadata for the QR Code template
string
required
Name of the QR Code template
integer
Margin to apply around the QR Code (in pixels)
boolean
Whether to set this template as the default for the organization
number
Scale factor for the QR Code dots (0-1)
string
Hex color code for dark modules (e.g., ‘#000000’ for black)
string
Text displayed within the frame (e.g., ‘SCAN ME’)
string
URL of the logo image
number
Scale factor for the logo (0.1-0.6)
string
Hex color code for light background (e.g., ‘#FFFFFF’ for white)
string
Hex color code for frame (e.g., ‘#000000’)
string ("none" | "banner-top" | "box-top" | "box-bottom" | "banner-bottom" | "balloon-top" | "balloon-bottom" | "circular")
Style of the QR Code frame (banner, box, balloon, or circular)
string ("square" | "circle" | "kite" | "left-diamond" | "right-diamond")
Pattern style for data modules
string
Hex color code for eye-ball modules (e.g., ‘#FF0000’)
string ("square" | "circle" | "rounded" | "left-leaf" | "right-leaf" | "left-diamond" | "right-diamond")
Shape of the eye-ball modules
string ("none" | "linear" | "radial" | "vertical")
Gradient type for the QR Code (none, linear, radial, vertical)
integer
required
ID of the organization to which this template belongs
string
Hex color code for eye-frame modules (e.g., ‘#00FF00’)
string ("square" | "circle" | "rounded" | "left-leaf" | "right-leaf")
Shape of the eye-frame modules (outer part of QR code positioning patterns)
string
Hex color code for frame text (e.g., ‘#FFFFFF’)
string
Hex color code for background (e.g., ‘#FFFFFF’)
string
URL of the background image

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_CREATE_TAGTool to create a new tag for organizing QR Codes and other objects. Use when you need to categorize QR Codes under a specific organization.

Input Parameters

string
required
Name of the tag. Must not exceed 128 characters. Supports Unicode characters including emoji.
integer
required
ID of the organization this tag belongs to. Use BEACONSTAC_LIST_ORGANIZATIONS to get valid organization IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_CREATE_USERCreate a new user under an organization for onboarding. This operation is available on Reseller plans and above.

Input Parameters

string
Email address of the User.
string
Password for the User. Uses default if not provided.
string
required
Username used to login.
string
Last name of the User.
string
First name of the User.
integer
required
ID of the organization to which the user belongs.
string
Billing email for the User. If not provided, defaults to username@example.com.
string ("ST" | "LT" | "BA" | "PR" | "RE" | "WL" | "EN")
required
Customer plan for the user: ST=Starter, LT=Lite, BA=Basic, PR=Premium, RE=Reseller, WL=Whitelabel, EN=Enterprise.
string
URL to the User’s profile picture.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_DELETE_QR_CODETool to delete a QR Code by its ID. Use when you need to remove an existing QR Code after validation.

Input Parameters

integer
required
Unique identifier of the QR Code to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_DELETE_QR_TEMPLATETool 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.

Input Parameters

integer
required
Unique identifier of the QR Code template to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_DELETE_TAGTool to delete a tag by its ID. Use when you need to remove an existing Tag after validation.

Input Parameters

integer
required
Unique identifier of the Tag to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_LIST_BULK_QR_CODESTool to list Bulk QR Code collections. Use when you need to filter, search, or order your bulk QR Code collections.

Input Parameters

integer
Page number for pagination (1-based index).
Full-text search on collection names.
string
Field to order results by. Prefix with ’-’ for descending. Allowed fields: name, created, updated.
integer
Number of collections per page, must be between 1 and 100.
integer
Filter by QR data type: 1=Website, 2=SMS, 3=Phone, 4=Email, 5=vCard, 6=Text.
string
Filter collections by name containing this substring (case-insensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_LIST_ORGANIZATIONSList 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.

Input Parameters

integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of organizations to return per page. Controls the pagination size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_LIST_PLACESTool to list your Places. Use when you need to browse or search your account’s Places with filtering and ordering.

Input Parameters

string
Filter by place name. Supports exact match.
integer
Page number to retrieve, must be >= 1.
string
Search for place names matching this value (case-insensitive partial match).
string
Comma-separated ordering fields; prefix with ’-’ for descending. Fields: name, created, updated, address.
integer
Number of places per page, must be between 1 and 100.
string
Filter by place name (case-insensitive contains).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_LIST_QR_TEMPLATESList QR code templates for a specified organization, with optional name filtering and pagination.

Input Parameters

integer
Page number for pagination (1-based index).
integer
Number of items per page.
integer
required
ID of the organization to list templates for.
string
Case-insensitive substring to filter template names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_LIST_TAGSTool to list all tags with optional filtering and pagination. Use when you need to browse or search tags in your account.

Input Parameters

integer
Page number to retrieve, must be >= 1.
string
Field by which to order results. Prefix with ’-’ for descending.
integer
Number of tags per page, must be between 1 and 100.
string
Filter tags by name containing this substring.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_LIST_USERSTool to list all users with optional filtering, searching, ordering, and pagination. Use when you need to retrieve user records across your organization.

Input Parameters

integer
Page number to retrieve, must be >= 1.
string
Full-text search across username, email, user_group, first_name, and last_name.
string
Comma-separated ordering fields. Supported: username, email, date_joined, user_group, first_name, last_name. Prefix with ’-’ for descending order.
integer
Number of users per page, must be between 1 and 100.
string
Filter by email exact match.
integer
Filter by organization ID exact match.
string
Filter by customer plan exact match.
string
Filter by date joined greater than this ISO 8601 timestamp.
string
Filter by date joined less than this ISO 8601 timestamp.
string
Filter by username exact match.
string
Filter by date joined greater than or equal to this ISO 8601 timestamp.
string
Filter by date joined less than or equal to this ISO 8601 timestamp.
string
Filter by email case-insensitive substring.
string
Filter by last name exact match.
string
Filter by first name exact match.
string
Filter by subscription state exact match.
string
Filter by username case-insensitive substring.
string
Filter by last name case-insensitive substring.
string
Filter by first name case-insensitive substring.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_PERIOD_OVERVIEWTool to get period overview analytics for products including counts, impressions, and conversion percentage. Use after specifying the product_type and time interval.

Input Parameters

integer
required
Organization ID for which analytics overview is requested.
string ("beacon" | "nfc" | "qr" | "geofence")
required
Type of product to fetch overview analytics for.
integer
required
End time in EPOCH milliseconds.
integer
required
Start time in EPOCH milliseconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_PRODUCT_OVERVIEWTool 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.

Input Parameters

integer
required
Organization ID for which overview is requested.
string ("beacon" | "nfc" | "qr" | "geofence")
required
Type of product to fetch overview for.
integer
required
End time in EPOCH milliseconds.
integer
required
Start time in EPOCH milliseconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_RETRIEVE_QR_CODERetrieve 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.

Input Parameters

integer
required
Unique identifier of the QR Code to retrieve. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_RETRIEVE_USERTool to retrieve the details of an existing User by ID. Use when you need to fetch a user’s profile after confirming its existence.

Input Parameters

integer
required
Unique identifier of the User to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_UPDATE_PLACETool to update the specified Place by ID. Use after retrieving the Place to modify its details, such as name, address, or coordinates.

Input Parameters

string
required
New name for the Place.
string
Address of the Place.
number
Latitude coordinate of the Place.
integer
required
Unique identifier of the Place to update.
number
Longitude coordinate of the Place.
integer
required
Organization ID this Place belongs to.
string
Business color as 6-character hex code without ’#’ (e.g., ‘FF5733’ for red-orange, used in NearBee).
string
Business icon URL (used in NearBee).
string
Business cover URL (used in NearBee).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_UPDATE_QR_CODEUpdate a QR Code by ID, including its name, design attributes, tags, and content. Returns available updated QR Code details.

Input Parameters

object
Metadata associated with the QR Code
string
New name for the QR Code
array
List of tag IDs to associate with the QR Code
integer
ID of the place where the QR Code is deployed
integer
QR type: 1=Static, 2=Dynamic. If provided, must include fields_data (for static) or campaign (for dynamic).
object
Campaign configuration for dynamic QR Codes. Required when qr_type=2. Example: {‘content_type’: 0, ‘custom_url’: ‘https://example.com’}
integer
required
ID of the QR Code to update
object
Design attributes for the QR Code (colors, logos, etc.)
object
Fields data for static QR Codes. Required when qr_type=1. Example: {‘qr_type’: 1, ‘url’: ‘https://example.com’}
integer
ID of the organization the QR Code belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_UPDATE_TAGTool 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.

Input Parameters

string
New name for the tag.
string
Hex color code for the tag, e.g., ‘#ff0000’.
integer
required
Unique identifier of the tag to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BEACONSTAC_UPDATE_USERTool to update an existing User. Use when you need to modify profile details or organization of a User by their ID.

Input Parameters

integer
required
Unique identifier of the User to update
string
New last name; leave unset to retain existing
string
New first name; leave unset to retain existing
integer
Organization ID to assign; leave unset to retain existing
string
URL to the User’s profile picture; leave unset to retain existing

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not