NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Beaconstac

beaconstac

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

MarketingMarketing AutomationWeb del proveedor
Acciones
21
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (21)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create PlaceBEACONSTAC_CREATE_PLACEAcción

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

Parámetros de entrada

  • namestringObligatorio

    Name of the place.

  • addressstringObligatorio

    Physical address of the place.

  • latitudestringObligatorio

    Latitude coordinate of the place.

  • longitudestringObligatorio

    Longitude coordinate of the place.

  • organizationintegerObligatorio

    ID of the organization this place belongs to.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create QR TemplateBEACONSTAC_CREATE_QR_TEMPLATEAcción

Tool to create a new qr code template. use when you need reusable design presets for qr codes.

Parámetros de entrada

  • metaobject

    Arbitrary metadata for the QR Code template

  • namestringObligatorio

    Name of the QR Code template

  • margininteger

    Margin to apply around the QR Code (in pixels)

  • defaultboolean

    Whether to set this template as the default for the organization

  • dotScalenumber

    Scale factor for the QR Code dots (0-1)

  • colorDarkany

    Hex color code for dark modules

  • frameTextstring

    Text displayed within the frame

  • logoImageanyuri

    URL of the logo image

  • logoScalenumber

    Scale factor for the logo (0.1-0.6)

  • colorLightany

    Hex color code for light background

  • frameColorany

    Hex color code for frame

  • frameStylestringenum

    Style of the QR Code frame

    nonebanner-topbox-topbox-bottombanner-bottomballoon-topcircular
  • dataPatternstringenum

    Pattern style for data modules

    squarecirclekiteleft-diamondright-diamond
  • eyeBallColorany

    Hex color code for eye-ball modules

  • eyeBallShapestringenum

    Shape of the eye-ball modules

    squarecircleroundedleft-leafright-leafleft-diamondright-diamond
  • gradientTypestringenum

    Gradient type for the QR Code

    nonelineaarradial
  • organizationintegerObligatorio

    ID of the organization to which this template belongs

  • eyeFrameColorany

    Hex color code for eye-frame modules

  • eyeFrameShapestringenum

    Shape of the eye-frame modules

    squarecircleroundedleft-leafright-leaf
  • frameTextColorany

    Hex color code for frame text

  • backgroundColorany

    Hex color code for background

  • backgroundImageanyuri

    URL of the background image

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create TagBEACONSTAC_CREATE_TAGAcción

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.

Parámetros de entrada

  • namestringObligatorio

    Name of the tag.

  • organizationintegerObligatorio

    ID of the organization this tag belongs to.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create UserBEACONSTAC_CREATE_USERAcción

Tool to create a new user. use when onboarding a new user under your organization (reseller plan and above).

Parámetros de entrada

  • emailstring

    Email address of the User.

  • passwordstring

    Password for the User. Uses default if not provided.

  • usernamestringObligatorio

    Username used to login.

  • last_namestring

    Last name of the User.

  • first_namestring

    First name of the User.

  • organizationintegerObligatorio

    ID of the organization to which the user belongs.

  • billing_emailstring

    Billing email for the User.

  • customer_planstringObligatorioenum

    Customer plan for the user: ST=Starter, LT=Lite, BA=Basic, PR=Premium, RE=Reseller, WL=Whitelabel, EN=Enterprise.

    STLTBAPRREWLEN
  • profile_picturestring

    URL to the User's profile picture.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete QR CodeBEACONSTAC_DELETE_QR_CODEAcción

Tool to delete a qr code by its id. use when you need to remove an existing qr code after validation.

Parámetros de entrada

  • idintegerObligatorio

    Unique identifier of the QR Code to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete QR Code TemplateBEACONSTAC_DELETE_QR_TEMPLATEAcción

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.

Parámetros de entrada

  • idintegerObligatorio

    Unique identifier of the QR Code template to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete TagBEACONSTAC_DELETE_TAGAcción

Tool to delete a tag by its id. use when you need to remove an existing tag after validation.

Parámetros de entrada

  • tag_idintegerObligatorio

    Unique identifier of the Tag to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Bulk QR Code CollectionsBEACONSTAC_LIST_BULK_QR_CODESAcción

Tool to list bulk qr code collections. use when you need to filter, search, or order your bulk qr code collections.

Parámetros de entrada

  • pageinteger

    Page number for pagination (1-based index).

  • searchstring

    Full-text search on collection names.

  • orderingstring

    Field to order results by. Prefix with '-' for descending. Allowed fields: name, created, updated.

  • page_sizeinteger

    Number of collections per page, must be between 1 and 100.

  • qr_data_typeinteger

    Filter by QR data type: 1=Website, 2=SMS, 3=Phone, 4=Email, 5=vCard, 6=Text.

  • name__icontainsstring

    Filter collections by name containing this substring (case-insensitive).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List OrganizationsBEACONSTAC_LIST_ORGANIZATIONSAcción

Tool to list organizations. use when you need to fetch all organizations accessible to the authenticated account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List PlacesBEACONSTAC_LIST_PLACESAcción

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

Parámetros de entrada

  • namestring

    Filter by place name. Supports exact match.

  • pageinteger

    Page number to retrieve, must be >= 1.

  • searchstring

    Search for place names matching this value (case-insensitive partial match).

  • orderingstring

    Comma-separated ordering fields; prefix with '-' for descending. Fields: name, created, updated, address.

  • page_sizeinteger

    Number of places per page, must be between 1 and 100.

  • name__icontainsstring

    Filter by place name (case-insensitive contains).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List QR TemplatesBEACONSTAC_LIST_QR_TEMPLATESAcción

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

Parámetros de entrada

  • pageinteger

    Page number for pagination (1-based index).

  • page_sizeinteger

    Number of items per page.

  • organizationintegerObligatorio

    ID of the organization to list templates for.

  • name__icontainsstring

    Case-insensitive substring to filter template names.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List TagsBEACONSTAC_LIST_TAGSAcción

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

Parámetros de entrada

  • pageinteger

    Page number to retrieve, must be >= 1.

  • orderingstring

    Field by which to order results. Prefix with '-' for descending.

  • page_sizeinteger

    Number of tags per page, must be between 1 and 100.

  • name__icontainsstring

    Filter tags by name containing this substring.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List UsersBEACONSTAC_LIST_USERSAcción

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

Parámetros de entrada

  • pageinteger

    Page number to retrieve, must be >= 1.

  • searchstring

    Full-text search across username, email, user_group, first_name, and last_name.

  • orderingstring

    Comma-separated ordering fields. Supported: username, email, date_joined, user_group, first_name, last_name. Prefix with '-' for descending order.

  • page_sizeinteger

    Number of users per page, must be between 1 and 100.

  • email__exactstring

    Filter by email exact match.

  • organizationinteger

    Filter by organization ID exact match.

  • customer_planstring

    Filter by customer plan exact match.

  • date_joined__gtstring

    Filter by date joined greater than this ISO 8601 timestamp.

  • date_joined__ltstring

    Filter by date joined less than this ISO 8601 timestamp.

  • username__exactstring

    Filter by username exact match.

  • date_joined__gtestring

    Filter by date joined greater than or equal to this ISO 8601 timestamp.

  • date_joined__ltestring

    Filter by date joined less than or equal to this ISO 8601 timestamp.

  • email__icontainsstring

    Filter by email case-insensitive substring.

  • last_name__exactstring

    Filter by last name exact match.

  • first_name__exactstring

    Filter by first name exact match.

  • subscription_statestring

    Filter by subscription state exact match.

  • username__icontainsstring

    Filter by username case-insensitive substring.

  • last_name__icontainsstring

    Filter by last name case-insensitive substring.

  • first_name__icontainsstring

    Filter by first name case-insensitive substring.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Period OverviewBEACONSTAC_PERIOD_OVERVIEWAcción

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

Parámetros de entrada

  • organizationintegerObligatorio

    Organization ID for which analytics overview is requested.

  • product_typestringObligatorioenum

    Type of product to fetch overview analytics for.

    beaconnfcqrgeofence
  • to_timestampintegerObligatorio

    End time in EPOCH milliseconds.

  • from_timestampintegerObligatorio

    Start time in EPOCH milliseconds.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Product OverviewBEACONSTAC_PRODUCT_OVERVIEWAcción

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.

Parámetros de entrada

  • organizationintegerObligatorio

    Organization ID for which overview is requested.

  • product_typestringObligatorioenum

    Type of product to fetch overview for.

    beaconnfcqrgeofence
  • to_timestampintegerObligatorio

    End time in EPOCH milliseconds.

  • from_timestampintegerObligatorio

    Start time in EPOCH milliseconds.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve QR CodeBEACONSTAC_RETRIEVE_QR_CODEAcción

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.

Parámetros de entrada

  • idintegerObligatorio

    Unique identifier of the QR Code to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve UserBEACONSTAC_RETRIEVE_USERAcción

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.

Parámetros de entrada

  • idintegerObligatorio

    Unique identifier of the User to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update PlaceBEACONSTAC_UPDATE_PLACEAcción

Tool to update the specified place by id. use after retrieving the place to modify its details, such as name, address, or coordinates.

Parámetros de entrada

  • namestringObligatorio

    New name for the Place.

  • addressstring

    Address of the Place.

  • latitudenumber

    Latitude coordinate of the Place.

  • place_idintegerObligatorio

    Unique identifier of the Place to update.

  • longitudenumber

    Longitude coordinate of the Place.

  • organizationintegerObligatorio

    Organization ID this Place belongs to.

  • business_colorstring

    Business color (used in NearBee).

  • business_icon_urlstring

    Business icon URL (used in NearBee).

  • business_cover_urlstring

    Business cover URL (used in NearBee).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update QR CodeBEACONSTAC_UPDATE_QR_CODEAcción

Tool to update an existing qr code by its id. use when you need to modify qr code attributes; only provided fields are changed.

Parámetros de entrada

  • metaobject

    Metadata associated with the QR Code

  • namestring

    New name for the QR Code

  • tagsinteger[]

    List of tag IDs to associate

  • placeinteger

    ID of the place where the QR Code is deployed

  • qr_typeinteger

    QR type: 1=Static, 2=Dynamic

  • campaignobject

    Campaign configuration for dynamic QR Codes (required if qr_type=2)

  • qrcode_idintegerObligatorio

    ID of the QR Code to update

  • attributesobject

    Design attributes for the QR Code

  • fields_dataobject

    Fields data for static QR Codes (required if qr_type=1)

  • organizationinteger

    ID of the organization the QR Code belongs to

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update TagBEACONSTAC_UPDATE_TAGAcción

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.

Parámetros de entrada

  • namestring

    New name for the tag.

  • colorstring

    Hex color code for the tag, e.g., '#ff0000'.

  • tag_idintegerObligatorio

    Unique identifier of the tag to update.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update UserBEACONSTAC_UPDATE_USERAcción

Tool to update an existing user. use when you need to modify profile details or organization of a user by their id.

Parámetros de entrada

  • user_idintegerObligatorio

    Unique identifier of the User to update

  • last_namestring

    New last name; leave unset to retain existing

  • first_namestring

    New first name; leave unset to retain existing

  • organizationinteger

    Organization ID to assign; leave unset to retain existing

  • profile_picturestring

    URL to the User's profile picture; leave unset to retain existing

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not