Beaconstac

Learn how to use Beaconstac with Composio

Overview

Enum

BEACONSTAC

Description

Beaconstac provides a platform for creating and managing QR codes and beacons, enabling businesses to engage customers through proximity marketing and track analytics.

Authentication Details

api_key
stringRequired

Actions

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

Action Parameters

address
stringRequired
latitude
stringRequired
longitude
stringRequired
name
stringRequired
organization
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to create a new qr code template. use when you need reusable design presets for qr codes.

Action Parameters

backgroundColor
backgroundImage
colorDark
colorLight
dataPattern
string
default
boolean
dotScale
number
eyeBallColor
eyeBallShape
string
eyeFrameColor
eyeFrameShape
string
frameColor
frameStyle
string
frameText
string
frameTextColor
gradientType
string
logoImage
logoScale
number
margin
integer
meta
object
name
stringRequired
organization
integerRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

name
stringRequired
organization
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to create a new user. use when onboarding a new user under your organization (reseller plan and above).

Action Parameters

billing_email
string
customer_plan
stringRequired
email
string
first_name
string
last_name
string
organization
integerRequired
password
string
profile_picture
string
username
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a qr code by its id. use when you need to remove an existing qr code after validation.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a tag by its id. use when you need to remove an existing tag after validation.

Action Parameters

tag_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to list bulk qr code collections. use when you need to filter, search, or order your bulk qr code collections.

Action Parameters

name__icontains
string
ordering
string
page
integerDefaults to 1
page_size
integerDefaults to 10
qr_data_type
integer
search
string

Action Response

data
object
error
string
successful
boolean
Tool to list organizations. use when you need to fetch all organizations accessible to the authenticated account.

Action Parameters

Action Response

data
array
error
string
successful
boolean
Tool to list your places. use when you need to browse or search your account's places with filtering and ordering.

Action Parameters

name
string
name__icontains
string
ordering
string
page
integerDefaults to 1
page_size
integerDefaults to 10
search
string

Action Response

data
object
error
string
successful
boolean
Tool to list all qr code templates in your account. use when you need to filter and paginate templates.

Action Parameters

name__icontains
string
organization
integerRequired
page
integer
page_size
integer

Action Response

data
object
error
string
successful
boolean
Tool to list all tags with optional filtering and pagination. use when you need to browse or search tags in your account.

Action Parameters

name__icontains
string
ordering
string
page
integerDefaults to 1
page_size
integerDefaults to 10

Action Response

data
object
error
string
successful
boolean
Tool to list all users with optional filtering, searching, ordering, and pagination. use when you need to retrieve user records across your organization.

Action Parameters

customer_plan
string
date_joined__gt
string
date_joined__gte
string
date_joined__lt
string
date_joined__lte
string
email__exact
string
email__icontains
string
first_name__exact
string
first_name__icontains
string
last_name__exact
string
last_name__icontains
string
ordering
string
organization
integer
page
integerDefaults to 1
page_size
integerDefaults to 10
search
string
subscription_state
string
username__exact
string
username__icontains
string

Action Response

data
object
error
string
successful
boolean
Tool to get period overview analytics for products including counts, impressions, and conversion percentage. use after specifying the product type and time interval.

Action Parameters

from_timestamp
integerRequired
organization
integerRequired
product_type
stringRequired
to_timestamp
integerRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

from_timestamp
integerRequired
organization
integerRequired
product_type
stringRequired
to_timestamp
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve details of a specific qr code by its id. use when you need to fetch or verify qr code properties after creation or update.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to update the specified place by id. use after retrieving the place to modify its details, such as name, address, or coordinates.

Action Parameters

address
string
business_color
string
business_cover_url
string
business_icon_url
string
latitude
number
longitude
number
name
stringRequired
organization
integerRequired
place_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to update an existing qr code by its id. use when you need to modify qr code attributes; only provided fields are changed.

Action Parameters

attributes
object
campaign
object
fields_data
object
meta
object
name
string
organization
integer
place
integer
qr_type
integer
qrcode_id
integerRequired
tags
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

color
string
name
string
tag_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to update an existing user. use when you need to modify profile details or organization of a user by their id.

Action Parameters

first_name
string
last_name
string
organization
integer
profile_picture
string
user_id
integerRequired

Action Response

data
object
error
string
successful
boolean