The Beamer connector lets your AI agent act in each user's Beamer account. Each user connects their own Beamer API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 49 tools.
- Tools
- 49
- What they doRead · write · destructive
- 26 · 14 · 926 read14 write9 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Beamer connection
In AgentKit > Connections, create a Beamer connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'beamer'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Beamer:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'beamer_feature_requests_count',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "beamer"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Beamer:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="beamer_feature_requests_count",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Beamer credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbeamer_feature_request_comment_getGet one comment on a feature request.Read-onlyGet Feature Request Comment
Get one comment on a feature request. Returns the comment's id, text, visibility, date and author details.
Inputs
comment_idintegerrequired- ID of the comment, from the matching comments list tool. Example: 7654321.
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
beamer_feature_request_comments_countCount comments on a feature request.Read-onlyCount Feature Request Comments
Count comments on a feature request. Returns the count.
Inputs
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
date_fromstring- Count comments published after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Count comments published before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
languagestring- Count comments with translations in this language. The language must follow the ISO-639 two-letter code format. Example: en.
searchstring- Count comments with content that contain this text. Example: dark mode.
visibleboolean- Count only visible (or not visible) comments. If unspecified, both types of comments will be retrieved. Example: true.
beamer_feature_request_comments_listList comments on a feature request, at most 10 per page.Read-onlyList Feature Request Comments
List comments on a feature request, at most 10 per page. Returns each comment's id, text, visibility, date and author details.
Inputs
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
date_fromstring- Retrieve comments published after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Retrieve comments published before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
languagestring- Retrieve comments with translations in this language. The language must follow the ISO-639 two-letter code format. Example: en.
max_resultsinteger- Maximum number of items to return per page (Beamer returns at most 10). Example: 10.
pageinteger- Page number to return, combined with max_results, starting at 1. Example: 1.
searchstring- Retrieve comments with content that contain this text. Example: dark mode.
visibleboolean- Retrieve only visible (or not visible) comments. If unspecified, both types of comments will be retrieved. Example: true.
beamer_feature_request_getGet one feature request.Read-onlyGet Feature Request
Get one feature request. Returns its id, translations, status, category, notes, visibility, vote and comment counts.
Inputs
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
beamer_feature_request_vote_getGet one vote on a feature request.Read-onlyGet Feature Request Vote
Get one vote on a feature request. Returns the vote's id, date and voter details.
Inputs
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
vote_idintegerrequired- ID of the vote, from beamer_feature_request_votes_list. Example: 112233.
beamer_feature_request_votes_countCount the votes on a feature request.Read-onlyCount Feature Request Votes
Count the votes on a feature request. Returns the count.
Inputs
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
beamer_feature_request_votes_listList the votes on a feature request, at most 10 per page.Read-onlyList Feature Request Votes
List the votes on a feature request, at most 10 per page. Returns each vote's id, date and voter details. Use beamer_feature_request_votes_count for the total.
Inputs
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
date_fromstring- Retrieve votes created after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Retrieve votes created before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
max_resultsinteger- Maximum number of items to return per page (Beamer returns at most 10). Example: 10.
pageinteger- Page number to return, combined with max_results, starting at 1. Example: 1.
beamer_feature_requests_countCount feature requests matching the same filters as beamer_feature_requests_list.Read-onlyCount Feature Requests
Count feature requests matching the same filters as beamer_feature_requests_list. Returns the count.
Inputs
categorystring- Count feature requests with this category. Example: new.
date_fromstring- Count feature requests created after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Count feature requests created before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
filtersstring- Count feature requests with a matching segmentation filter. (Only available on the Pro plan (and up)). Example: beta.
languagestring- Count feature requests with translations in this language. The language must follow the ISO-639 two-letter code format. Example: en.
searchstring- Count feature requests with title or content that contain this text. Example: dark mode.
statusstring- Count feature requests with this status. Example: under_review.
visibleboolean- Count only visible (or not visible) feature requests. If unspecified, both types of feature requests will be retrieved. Example: true.
beamer_feature_requests_listList feature requests (ideas) from the Beamer feedback board, filtered by date, category, status, visibility or text, at most 10 per page.Read-onlyList Feature Requests
List feature requests (ideas) from the Beamer feedback board, filtered by date, category, status, visibility or text, at most 10 per page. Returns each request's id, translations, status, category, vote and comment counts. Use this to find a feature request ID. Use beamer_feature_requests_count for totals.
Inputs
categorystring- Retrieve feature requests with this category. Example: new.
date_fromstring- Retrieve feature requests created after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Retrieve feature requests created before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
filtersstring- Retrieve feature requests with a matching segmentation filter. (Only available on the Pro plan (and up)). Example: beta.
languagestring- Retrieve feature requests with translations in this language. The language must follow the ISO-639 two-letter code format. Example: en.
max_resultsinteger- Maximum number of items to return per page (Beamer returns at most 10). Example: 10.
pageinteger- Page number to return, combined with max_results, starting at 1. Example: 1.
searchstring- Retrieve feature requests with title or content that contain this text. Example: dark mode.
statusstring- Retrieve feature requests with this status. Example: under_review.
visibleboolean- Retrieve only visible (or not visible) feature requests. If unspecified, both types of feature requests will be retrieved. Example: true.
beamer_feed_url_getGet the URL of your standalone Beamer changelog feed, optionally personalized for one viewer.Read-onlyGet Feed URL
Get the URL of your standalone Beamer changelog feed, optionally personalized for one viewer. Returns the feed URL. Use this to share or link to the public changelog.
Inputs
filterstring- Retrieve posts with a matching segmentation filter. (Only available on the Pro plan (and up)). Example: beta;admin.
filter_by_urlboolean- Whether to apply URL filtering to the feed. (Only available on the Pro plan (and up)). Example: true.
force_filterstring- Only retrieve posts that match this segmentation filter. (Only available on the Pro plan (and up)). Example: beta.
languagestring- Retrieve the URL for your feed in a specific language. The language must follow the ISO-639 two-letter code format. (Only available on the Starter plan (and up)). Example: en.
themestring- Theme class to use for appearance customization via CSS. (Only available on the Pro plan (and up)). Example: dark.
user_emailstring- Email of the user viewing the feed (for Analytics). Example: jane@example.com.
user_first_namestring- First name of the user viewing the feed (for Analytics). Example: Jane.
user_idstring- ID of the user viewing the feed (for Analytics). Example: user_123.
user_last_namestring- Last name of the user viewing the feed (for Analytics). Example: Doe.
beamer_nps_checkCheck whether an end user should be shown the NPS survey now, based on your NPS settings and their history.Read-onlyCheck NPS Prompt
Check whether an end user should be shown the NPS survey now, based on your NPS settings and their history. Returns whether to show the prompt. Identify the user with user_id, beamer_id or user_email.
Inputs
beamer_idstring- Beamer generated ID for the user. Example: 84391274.
created_atstring- Creation/signup date for this user. The date must follow the ISO-8601 format. Example: 2025-06-01T00:00:00Z.
filterstring- Segmentation filters applied to this user. Example: beta;admin.
languagestring- Language of the user. Example: en.
mobileboolean- Whether this user is coming from a mobile device. If unspecified, it will be considered false. Example: true.
multiboolean- Only applicable if using the userId parameter. If true, Beamer will consider different userId s strictly as different users - even if the userIds are associated to the same browser or device. If unspecified, it will be considered false. Example: true.
urlstring- Current URL (where the user is at now). Example: https://app.example.com/settings.
user_emailstring- Email of the user. Example: jane@example.com.
user_first_namestring- First name of the user. Example: Jane.
user_idstring- ID of the user (as defined in the embedded script's user_id parameter). Example: user_123.
user_last_namestring- Last name of the user. Example: Doe.
beamer_nps_link_getGet a personal NPS survey link for an end user, to send yourself.Read-onlyGet NPS Survey Link
Get a personal NPS survey link for an end user, to send yourself. Returns the survey URL. Use beamer_nps_email_send to have Beamer email the survey instead.
Inputs
user_emailstring- Email of the user to generate the NPS survey link for. Example: jane@example.com.
user_first_namestring- First name of the user to survey. Example: Jane.
user_idstring- ID of the user to generate the NPS survey link for. Example: user_123.
user_last_namestring- Last name of the user to survey. Example: Doe.
beamer_nps_responses_countCount NPS survey responses matching date, score or text filters.Read-onlyCount NPS Responses
Count NPS survey responses matching date, score or text filters. Returns the count.
Inputs
date_fromstring- Retrieve NPS responses sent after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Retrieve NPS responses sent before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
score_frominteger- Retrieve NPS responses with a score of this value or greater. Example: 0.
score_tointeger- Retrieve NPS responses with a score of this value or less. Example: 6.
searchstring- Retrieve NPS responses with feedback that contains this text. The search value can also match the name of the user. Example: dark mode.
beamer_nps_responses_listList NPS survey responses, filtered by date, score range or text, at most 10 per page.Read-onlyList NPS Responses
List NPS survey responses, filtered by date, score range or text, at most 10 per page. Returns each response's id, date, score, feedback text and user details. Use beamer_nps_responses_count for totals.
Inputs
date_fromstring- Retrieve NPS responses sent after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Retrieve NPS responses sent before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
max_resultsinteger- Maximum number of items to return per page (Beamer returns at most 10). Example: 10.
pageinteger- Page number to return, combined with max_results, starting at 1. Example: 1.
score_frominteger- Retrieve NPS responses with a score of this value or greater. Example: 0.
score_tointeger- Retrieve NPS responses with a score of this value or less. Example: 6.
searchstring- Retrieve NPS responses with feedback that contains this text. The search value can also match the name of the user. Example: dark mode.
beamer_pingCheck that the Beamer API key works.Read-onlyPing
Check that the Beamer API key works. Returns the name of your Beamer product. Use this to confirm the connection.
Inputs
This tool takes no inputs.
beamer_post_comment_getGet one comment on a changelog post.Read-onlyGet Post Comment
Get one comment on a changelog post. Returns the comment's id, text, date and author details. Use beamer_post_comments_list to find the comment ID.
Inputs
comment_idintegerrequired- ID of the comment, from the matching comments list tool. Example: 7654321.
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
beamer_post_comments_countCount comments on a changelog post, with the same filters as beamer_post_comments_list.Read-onlyCount Post Comments
Count comments on a changelog post, with the same filters as beamer_post_comments_list. Returns the count.
Inputs
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
date_fromstring- Retrieve comments published after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Retrieve comments published before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
languagestring- Retrieve comments with translations in this language. The language must follow the ISO-639 two-letter code format. Example: en.
searchstring- Retrieve comments with content that contain this text. Example: dark mode.
beamer_post_comments_listList comments users left on a changelog post, at most 10 per page.Read-onlyList Post Comments
List comments users left on a changelog post, at most 10 per page. Returns each comment's id, text, date and author details. Use beamer_post_comments_count for the total.
Inputs
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
date_fromstring- Retrieve comments published after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Retrieve comments published before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
languagestring- Retrieve comments with translations in this language. The language must follow the ISO-639 two-letter code format. Example: en.
max_resultsinteger- Maximum number of items to return per page (Beamer returns at most 10). Example: 10.
pageinteger- Page number to return, combined with max_results, starting at 1. Example: 1.
searchstring- Retrieve comments with content that contain this text. Example: dark mode.
beamer_post_getGet one changelog post.Read-onlyGet Post
Get one changelog post. Returns its id, date, translations (title, content, link), category, flags and view, click and feedback counts. Use beamer_posts_list to find the post ID.
Inputs
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
ignore_request_detailsboolean- Whether request-specific details should be ignored (this includes IP, browser/OS and geolocation details). Useful when sending requests from your backend, where the request's details aren't representative of the end user. Example: true.
languagestring- ID of the user viewing these posts (for Analytics). Example: en.
traceable_linksboolean- Whether links in the post should be converted to a traceable format (both the CTA and links within the content). If true, the opened URL will be tracked and record a 'click' entry in your Analytics. Example: true.
user_emailstring- Email of the user viewing these posts (for Analytics). Example: jane@example.com.
user_first_namestring- First name of the user viewing these posts (for Analytics). Example: Jane.
user_idstring- ID of the user viewing these posts (for Analytics). Example: user_123.
user_last_namestring- Last name of the user viewing these posts (for Analytics). Example: Doe.
beamer_post_reaction_getGet one reaction on a changelog post.Read-onlyGet Post Reaction
Get one reaction on a changelog post. Returns the reaction's id, type, date and user details.
Inputs
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
reaction_idintegerrequired- ID of the reaction, from beamer_post_reactions_list. Example: 456789.
beamer_post_reactions_countCount reactions on a changelog post, optionally of one type.Read-onlyCount Post Reactions
Count reactions on a changelog post, optionally of one type. Returns the count.
Inputs
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
date_fromstring- Retrieve reactions published after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Retrieve reactions published before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
reactionstring- Retrieve reactions with this reaction type (positive, neutral or negative). Example: positive.
beamer_post_reactions_listList reactions (positive, neutral or negative) users gave a changelog post, at most 10 per page.Read-onlyList Post Reactions
List reactions (positive, neutral or negative) users gave a changelog post, at most 10 per page. Returns each reaction's id, type, date and user details. Use beamer_post_reactions_count for totals.
Inputs
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
date_fromstring- Retrieve reactions published after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Retrieve reactions published before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
max_resultsinteger- Maximum number of items to return per page (Beamer returns at most 10). Example: 10.
pageinteger- Page number to return, combined with max_results, starting at 1. Example: 1.
reactionstring- Retrieve reactions with this reaction type (positive, neutral or negative). Example: positive.
beamer_posts_countCount changelog posts that match the same filters as beamer_posts_list.Read-onlyCount Posts
Count changelog posts that match the same filters as beamer_posts_list. Returns the count. Use this for totals without fetching the posts.
Inputs
archivedboolean- Count only archived (or not archived) posts. If unspecified, both types of posts will be counted. Example: true.
categorystring- Count posts with this category. Example: new.
date_fromstring- Count posts published after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Count posts published before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
expiredboolean- Count only expired (or not expired) posts; posts without an expiration date are considered not expired. If unspecified, both types of posts will be counted. Example: true.
filterstring- Count posts with a matching segmentation filter. (Only available on the Pro plan (and up)). Example: beta;admin.
filter_by_user_idboolean- If true, single-user posts will be counted when matching the userId parameter. If false (or if no userId is provided), single-user posts will not be counted. (Only available on the Scale plan). Example: true.
filter_urlstring- If URL segmentation is enabled, include posts with a matching segmentation URL. (Only available on the Pro plan (and up)). Example: https://app.example.com/dashboard.
force_filterstring- Only count posts that match this segmentation filter. (Only available on the Pro plan (and up)). Example: beta.
ignore_filtersboolean- If true, all posts will be counted, ignoring any segmentation they may have. This parameter should only be used for requests sent from the backend. [In order to user this parameter, the API key should have the 'Read posts (ignore filters)' permission enabled.]. Example: true.
languagestring- Count posts with translations in this language. The language must follow the ISO-639 two-letter code format. (Only available on the Starter plan (and up)). Example: en.
publishedboolean- Count only published (or draft) posts. If unspecified, both types of posts will be counted. Example: true.
user_idstring- For using with the filterByUserId parameter only. Example: user_123.
beamer_posts_listList changelog posts, filtered by date, category, language, status or segment, at most 10 per page.Read-onlyList Posts
List changelog posts, filtered by date, category, language, status or segment, at most 10 per page. Returns each post's id, date, translations (title, content, link), category, flags and view counts. Use this to browse or find a post ID. Use beamer_posts_count for totals, beamer_unread_posts_list for one user's unread posts and beamer_post_get for one post.
Inputs
archivedboolean- Retrieve only archived (or not archived) posts. If unspecified, both types of posts will be retrieved. Example: true.
categorystring- Retrieve posts with this category. Example: new.
date_fromstring- Retrieve posts published after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
date_tostring- Retrieve posts published before this date. The date must follow the ISO-8601 format. Example: 2026-01-31T23:59:59Z.
expiredboolean- Retrieve only expired (or not expired) posts; posts without an expiration date are considered not expired. If unspecified, both types of posts will be retrieved. (Only available on the Starter plan (and up)). Example: true.
filterstring- Retrieve posts with a matching segmentation filter. (Only available on the Pro plan (and up)). Example: beta;admin.
filter_by_user_idboolean- If true, single-user posts will be retrieved when matching the userId parameter. If false (or if no userId is provided), single-user posts will not be retrieved. (Only available on the Scale plan). Example: true.
filter_urlstring- If URL segmentation is enabled, include posts with a matching segmentation URL. (Only available on the Pro plan (and up)). Example: https://app.example.com/dashboard.
force_filterstring- Only retrieve posts that match this segmentation filter. (Only available on the Pro plan (and up)). Example: beta.
ignore_filtersboolean- If true, all posts will be retrieved, ignoring any segmentation they may have. This parameter should only be used for requests sent from the backend. [In order to user this parameter, the API key should have the 'Read posts (ignore filters)' permission enabled.]. Example: true.
ignore_request_detailsboolean- Whether request-specific details should be ignored (this includes IP, browser/OS and geolocation details). Useful when sending requests from your backend, where the request's details aren't representative of the end user. Example: true.
languagestring- Retrieve posts with translations in this language. The language must follow the ISO-639 two-letter code format. Example: en.
max_resultsinteger- Maximum number of items to return per page (Beamer returns at most 10). Example: 10.
pageinteger- Page number to return, combined with max_results, starting at 1. Example: 1.
publishedboolean- Retrieve only published (or draft) posts. If unspecified, both types of posts will be retrieved. Example: true.
save_viewsboolean- Whether to save views for the posts retrieved (for Analytics). If unspecified, views are saved. Example: true.
traceable_linksboolean- Whether links in the post should be converted to a traceable format (both the CTA and links within the content). If true, the opened URL will be tracked and record a 'click' entry in your Analytics. Example: true.
user_emailstring- Email of the user viewing these posts (for Analytics). Example: jane@example.com.
user_first_namestring- First name of the user viewing these posts (for Analytics). Example: Jane.
user_idstring- ID of the user viewing these posts (for Analytics). Example: user_123.
user_last_namestring- Last name of the user viewing these posts (for Analytics). Example: Doe.
beamer_unread_posts_countCount the changelog posts one end user has not read yet.Read-onlyCount Unread Posts
Count the changelog posts one end user has not read yet. Returns the count. Identify the user with user_id or user_email.
Inputs
categorystring- Count posts with this category. Example: new.
date_fromstring- Count posts published after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
filterstring- Count posts with a matching segmentation filter. (Only available on the Pro plan (and up)). Example: beta;admin.
filter_urlstring- If URL segmentation is enabled, include posts with a matching segmentation URL. (Only available on the Pro plan (and up)). Example: https://app.example.com/dashboard.
force_filterstring- Only count posts that match this segmentation filter. (Only available on the Pro plan (and up)). Example: beta.
ignore_filtersboolean- If true, all posts will be counted, ignoring any segmentation they may have. This parameter should only be used for requests sent from the backend. [In order to user this parameter, the API key should have the 'Read posts (ignore filters)' permission enabled.]. Example: true.
languagestring- Count posts with translations in this language. The language must follow the ISO-639 two-letter code format. Example: en.
themestring- Theme class to use for appearance customization via CSS. (Only available on the Pro plan (and up)). Example: dark.
user_emailstring- Email of the user viewing these posts (for Analytics). Example: jane@example.com.
user_first_namestring- First name of the user viewing these posts (for Analytics). Example: Jane.
user_idstring- ID of the user viewing these posts (for Analytics). If single-user posts are enabled, posts with a matching userId will be counted. (Only available on the Scale plan) If multi-device synchronization is enabled, the dateFrom parameter will be overridden by this user's last date of viewing your feed - if any. dateFrom can be omitted in this case. (Only available on the Pro plan (and up)). Example: user_123.
user_last_namestring- Last name of the user viewing these posts (for Analytics). Example: Doe.
beamer_users_listList end users recorded in Beamer Analytics, optionally one user by ID or email, sorted by any attribute.Read-onlyList Users
List end users recorded in Beamer Analytics, optionally one user by ID or email, sorted by any attribute. Returns each user's beamerId, userId, email, name, language, location, device and activity dates. Use this to look up a user's Beamer ID.
Inputs
beamer_idstring- Beamer generated ID for the user. Example: 84391274.
max_resultsinteger- Maximum number of items to return per page (Beamer returns at most 10). Example: 10.
pageinteger- Page number to return, combined with max_results, starting at 1. Example: 1.
sortstring- Sort users by this attribute (in ascending order). This parameter can contain any of the user attributes returned by this endpoint, including custom attributes. Adding a hyphen ('-') before the attribute will sort the results in descending order. For example, sort=lastSeen will first retrieve users with the oldest 'last seen' date, while sort=-lastSeen will retrieve users that were 'last seen' most recently. By default, users are sorted by firstSeen (oldest first). Example: -lastSeen.
user_emailstring- Email of the user. Example: jane@example.com.
user_idstring- ID of the user (as defined in the embedded script's user_id parameter). Example: user_123.
beamer_feature_request_comment_createAdd a comment to a feature request on behalf of an end user.WriteCreate Feature Request Comment
Add a comment to a feature request on behalf of an end user. Returns the created comment. Identify the end user with user_id, user_email, user_firstname or user_lastname.
Inputs
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
textstringrequired- Content of the comment. Example: Love this update!.
user_emailstring- Email of the end user who created this comment. Example: jane@example.com.
user_firstnamestring- First name of the end user who created this comment. Example: Jane.
user_idstring- ID of the end user who created this comment. Example: user_123.
user_lastnamestring- Last name of the end user who created this comment. Example: Doe.
visibleboolean- Whether this comment should be visible or not. Example: true.
beamer_feature_request_createCreate a feature request on the Beamer feedback board, as a team member or on behalf of an end user.WriteCreate Feature Request
Create a feature request on the Beamer feedback board, as a team member or on behalf of an end user. Returns the created feature request. Send internal_user_email for a team member, or at least one of user_id, user_email, user_firstname or user_lastname for an end user.
Inputs
titlearrayrequired- Feature request title, as an array with one entry per translation, for example ["Add dark mode"]. Example: ["Add dark mode"]
categorystring- Category of the feature request. Example: UI.
contentarray- Feature request description, as an array with one entry per translation. Example: ["It would be great to have a dark theme."]
datestring- Publication date for this post in ISO-8601 format. [Future dates / post scheduling are only available on the Starter plan (and up)]. Example: 2026-02-01T09:00:00Z.
filtersstring- Segmentation filters for the feature request. Example: beta.
internal_user_emailstring- Email of the user in your account creating this feature request (if created by a team member). [Required if not sending userId , userEmail , userFirstname or _userLastname_] . Example: pm@example.com.
languagearray- ISO-639 two-letter language of each translation, for example ["en"] (Starter plan and up). Example: ["en"]
notesstring- Notes for the feature request. Example: Planned for Q3.
statusstring- Status of the feature request, for example under_review, planned, in_progress or complete (as configured in Beamer). Example: under_review.
user_emailstring- Email of the end user creating this feature request (if created by an end user). [If not sending internalUserEmail , at least one of userId , userEmail , userFirstname or userLastname are required] . Example: jane@example.com.
user_firstnamestring- First name of the end user creating this feature request (if created by an end user). [If not sending internalUserEmail , at least one of userId , userEmail , userFirstname or userLastname are required] . Example: Jane.
user_idstring- ID of the end user creating this feature request (if created by an end user). [If not sending internalUserEmail , at least one of userId , userEmail , userFirstname or userLastname are required] . Example: user_123.
user_lastnamestring- Last name of the end user creating this feature request (if created by an end user). [If not sending internalUserEmail , at least one of userId , userEmail , userFirstname or userLastname are required] . Example: Doe.
visibleboolean- Whether this feature request should be visible in your feed. Example: true.
votes_countinteger- Number of votes to create for this feature request. Example: 3.
beamer_feature_request_updateUpdate a feature request's text, status, category, notes or visibility.WriteUpdate Feature Request
Update a feature request's text, status, category, notes or visibility. Returns the updated feature request. Only the fields you set are sent.
- Idempotent
Inputs
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
categorystring- Category of the feature request. Example: UI.
contentarray- Feature request description, as an array with one entry per translation. Example: ["It would be great to have a dark theme."]
datestring- Publication date for this post in ISO-8601 format. [Future dates / post scheduling are only available on the Starter plan (and up)]. Example: 2026-02-01T09:00:00Z.
filtersstring- Segmentation filters for the feature request. Example: beta.
languagearray- ISO-639 two-letter language of each translation, for example ["en"] (Starter plan and up). Example: ["en"]
notesstring- Notes for the feature request. Example: Planned for Q3.
statusstring- Status of the feature request, for example under_review, planned, in_progress or complete (as configured in Beamer). Example: under_review.
titlearray- Feature request title, as an array with one entry per translation, for example ["Add dark mode"]. Example: ["Add dark mode"]
visibleboolean- Whether this feature request should be visible in your feed. Example: true.
beamer_feature_request_vote_createAdd an end user's vote to a feature request.WriteCreate Feature Request Vote
Add an end user's vote to a feature request. Returns the created vote. Identify the end user with user_id, user_email, user_firstname or user_lastname.
Inputs
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
user_emailstring- Email of the end user who created this vote. Example: jane@example.com.
user_firstnamestring- First name of the end user who created this vote. Example: Jane.
user_idstring- ID of the end user who created this vote. Example: user_123.
user_lastnamestring- Last name of the end user who created this vote. Example: Doe.
beamer_nps_email_sendEmail an NPS survey to an end user.WriteSend NPS Email Survey
Email an NPS survey to an end user. Returns a confirmation. Use beamer_nps_link_get to get a link without sending an email.
Inputs
user_emailstringrequired- Email address to send the NPS survey to. Example: jane@example.com.
beamer_post_comment_createAdd a comment to a changelog post on behalf of an end user.WriteCreate Post Comment
Add a comment to a changelog post on behalf of an end user. Returns the created comment. Identify the end user with user_id, user_email, user_firstname or user_lastname.
Inputs
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
textstringrequired- Content of the comment. Example: Love this update!.
user_emailstring- Email of the end user who created this comment. Example: jane@example.com.
user_firstnamestring- First name of the end user who created this comment. Example: Jane.
user_idstring- ID of the end user who created this comment. Example: user_123.
user_lastnamestring- Last name of the end user who created this comment. Example: Doe.
beamer_post_createCreate a changelog post, published right away or saved as a draft, optionally in several languages.WriteCreate Post
Create a changelog post, published right away or saved as a draft, optionally in several languages. Returns the created post with its id. title, content, language, link_url and link_text are arrays with one entry per translation, in matching order.
Inputs
categorystringrequired- Post category: new, improvement, fix, comingsoon, announcement or other (custom categories on paid plans). Separate several with semicolons. Example: new.
contentarrayrequired- Post body (HTML allowed), as an array with one entry per translation. Array with one entry per translation, in the same order as the other per-translation arrays (title, content, language, link_url, link_text). Example: ["<p>You can now switch to dark mode from Settings.</p>"]
titlearrayrequired- Post title, as an array with one entry per translation, for example ["Dark mode is here"]. Array with one entry per translation, in the same order as the other per-translation arrays (title, content, language, link_url, link_text). Example: ["Dark mode is here"]
archiveboolean- Whether to archive this post or not. Example: true.
auto_openboolean- Enable this to automatically open Beamer's sidebar the first time the user gets this post (Only available on the Starter plan (and up)) Deprecated. Example: true.
boosted_announcementstring- Type of boosted announcement to set for this post. (Only available with the Boosted Announcements add-on). Example: snippet.one of
top-barpopupsnippettooltip datestring- Publication date for this post in ISO-8601 format. [Future dates / post scheduling are only available on the Starter plan (and up)]. Example: 2026-02-01T09:00:00Z.
due_datestring- Expiration date for this post in ISO-8601 format. (Only available on the Starter plan (and up)). Example: 2026-03-01T00:00:00Z.
enable_feedbackboolean- Whether to enable or disable user feedback for this post (Only available on the Pro plan (and up)). Example: true.
enable_reactionsboolean- Whether to enable or disable user reactions for this post (Only available on the Pro plan (and up)). Example: true.
enable_social_shareboolean- Enable this to show options for your users to share this post on social media . Example: true.
filterstring- Segmentation filter (or filters) for this post. (Only available on the Pro plan (and up)). Example: beta;admin.
filter_urlstring- URL where the post is shown; * is a wildcard and several URLs are separated by semicolons (Pro plan and up). Example: https://app.example.com/dashboard.
filter_user_idstring- User ID to apply as a filter. This post will only be shown to users that have the same ' user_id ' parameter in the embedded script. Multiple IDs can be passed in, separated by semicolons (;). (Only available on the Scale plan). Example: user_123;user_456.
fixed_boosted_announcementboolean- Enable this for the post to be shown as a fixed top-bar announcement. Example: true.
languagearray- ISO-639 two-letter language of each translation, for example ["en", "es"]. Array with one entry per translation, in the same order as the other per-translation arrays (title, content, language, link_url, link_text) (Starter plan and up). Example: ["en"]
link_textarray- Call-to-action link text per translation. Array with one entry per translation, in the same order as the other per-translation arrays (title, content, language, link_url, link_text). Example: ["Read more"]
link_urlarray- Call-to-action URL per translation, opened when the header or bottom link is clicked. Array with one entry per translation, in the same order as the other per-translation arrays (title, content, language, link_url, link_text). Example: ["https://example.com/blog/dark-mode"]
links_in_new_windowboolean- Whether to open links in a new window/tab (true) or in the same window/tab (false) for this post. Example: true.
pinnedboolean- Whether this post should be pinned to the top of the feed. (Only available on the Starter plan (and up)). Example: true.
publishboolean- Whether to publish this post or save it as a draft. Example: true.
send_push_notificationboolean- Enable this to send a web push notification for this post to all your subscribed users. (Only available on the Pro plan (and up)). Example: true.
show_in_standaloneboolean- Whether this post should show up in the standalone feed . Example: true.
show_in_widgetboolean- Whether this post should show up in the embedded feed . Example: true.
user_emailstring- Email of the user in your account creating this post. Example: jane@example.com.
beamer_post_reaction_createRecord an end user's reaction (positive, neutral or negative) to a changelog post.WriteCreate Post Reaction
Record an end user's reaction (positive, neutral or negative) to a changelog post. Returns the created reaction. Identify the end user with user_id, user_email, user_firstname or user_lastname.
Inputs
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
reactionstringrequired- Reaction type: positive, neutral or negative. Example: positive.
user_emailstring- Email of the end user who created this reaction. Example: jane@example.com.
user_firstnamestring- First name of the end user who created this reaction. Example: Jane.
user_idstring- ID of the end user who created this reaction. Example: user_123.
user_lastnamestring- Last name of the end user who created this reaction. Example: Doe.
beamer_post_updateUpdate an existing changelog post's translations, category, publish state, dates or segmentation.WriteUpdate Post
Update an existing changelog post's translations, category, publish state, dates or segmentation. Returns the updated post. Only the fields you set are sent. Per-translation arrays follow the same order rules as beamer_post_create.
- Idempotent
Inputs
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
archiveboolean- Whether to archive this post or not. Example: true.
auto_openboolean- Enable this to automatically open Beamer's sidebar the first time the user gets this post (Only available on the Starter plan (and up)) Deprecated. Example: true.
boosted_announcementstring- Type of boosted announcement to set for this post. (Only available with the Boosted Announcements add-on). Example: snippet.one of
top-barpopupsnippettooltip categorystring- Post category: new, improvement, fix, comingsoon, announcement or other (custom categories on paid plans). Separate several with semicolons. Example: new.
contentarray- Post body (HTML allowed), as an array with one entry per translation. Array with one entry per translation, in the same order as the other per-translation arrays (title, content, language, link_url, link_text). Example: ["<p>You can now switch to dark mode from Settings.</p>"]
datestring- Publication date for this post in ISO-8601 format. [Future dates / post scheduling are only available on the Starter plan (and up)]. Example: 2026-02-01T09:00:00Z.
due_datestring- Expiration date for this post in ISO-8601 format. (Only available on the Starter plan (and up)). Example: 2026-03-01T00:00:00Z.
enable_feedbackboolean- Whether to enable or disable user feedback for this post (Only available on the Pro plan (and up)). Example: true.
enable_reactionsboolean- Whether to enable or disable user reactions for this post (Only available on the Pro plan (and up)). Example: true.
enable_social_shareboolean- Enable this to show options for your users to share this post on social media . Example: true.
filterstring- Segmentation filter (or filters) for this post. (Only available on the Pro plan (and up)). Example: beta;admin.
filter_urlstring- URL where the post is shown; * is a wildcard and several URLs are separated by semicolons (Pro plan and up). Example: https://app.example.com/dashboard.
filter_user_idstring- User ID to apply as a filter. This post will only be shown to users that have the same ' user_id ' parameter in the embedded script. Multiple IDs can be passed in, separated by semicolons (;). (Only available on the Scale plan). Example: user_123;user_456.
fixed_boosted_announcementboolean- Enable this for the post to be shown as a fixed top-bar announcement. Example: true.
languagearray- ISO-639 two-letter language of each translation, for example ["en", "es"]. Array with one entry per translation, in the same order as the other per-translation arrays (title, content, language, link_url, link_text) (Starter plan and up). Example: ["en"]
link_textarray- Call-to-action link text per translation. Array with one entry per translation, in the same order as the other per-translation arrays (title, content, language, link_url, link_text). Example: ["Read more"]
link_urlarray- Call-to-action URL per translation, opened when the header or bottom link is clicked. Array with one entry per translation, in the same order as the other per-translation arrays (title, content, language, link_url, link_text). Example: ["https://example.com/blog/dark-mode"]
links_in_new_windowboolean- Whether to open links in a new window/tab (true) or in the same window/tab (false) for this post. Example: true.
pinnedboolean- Whether this post should be pinned to the top of the feed. (Only available on the Starter plan (and up)). Example: true.
publishboolean- Whether to publish this post or save it as a draft. Example: true.
send_push_notificationboolean- Enable this to send a web push notification for this post to all your subscribed users. (Only available on the Pro plan (and up)). Example: true.
show_in_standaloneboolean- Whether this post should show up in the standalone feed . Example: true.
show_in_widgetboolean- Whether this post should show up in the embedded feed . Example: true.
titlearray- Post title, as an array with one entry per translation, for example ["Dark mode is here"]. Array with one entry per translation, in the same order as the other per-translation arrays (title, content, language, link_url, link_text). Example: ["Dark mode is here"]
user_emailstring- Email of the user in your account creating this post. Example: jane@example.com.
beamer_team_member_inviteInvite someone to your Beamer team with a role.WriteInvite Team Member
Invite someone to your Beamer team with a role. Returns the invited team member. Roles: admin, manager, writer, designer, reader or billing.
Inputs
emailstringrequired- Email address of the person to invite. Example: teammate@example.com.
rolestringrequired- Role to give: admin, manager, writer, designer, reader or billing. Example: writer.one of
adminmanagerwriterdesignerreaderbilling
beamer_team_member_role_updateChange the role of a member of your Beamer team.WriteUpdate Team Member Role
Change the role of a member of your Beamer team. Returns the updated team member. Roles: admin, manager, writer, designer, reader or billing.
- Idempotent
Inputs
emailstringrequired- Email address of the team member. Example: teammate@example.com.
rolestringrequired- New role: admin, manager, writer, designer, reader or billing. Example: writer.one of
adminmanagerwriterdesignerreaderbilling
beamer_unread_posts_listList the changelog posts one end user has not read yet, and by default mark them as read.WriteList Unread Posts
List the changelog posts one end user has not read yet, and by default mark them as read. Returns the unread posts with their translations and links. Identify the user with user_id or user_email. Set mark_as_read=false to only peek. Use beamer_unread_posts_count for a badge count.
Inputs
categorystring- Retrieve posts with this category. Example: new.
date_fromstring- Retrieve posts published after this date. The date must follow the ISO-8601 format. Example: 2026-01-01T00:00:00Z.
filterstring- Retrieve posts with a matching segmentation filter. (Only available on the Pro plan (and up)). Example: beta;admin.
filter_urlstring- If URL segmentation is enabled, include posts with a matching segmentation URL. (Only available on the Pro plan (and up)). Example: https://app.example.com/dashboard.
force_filterstring- Only retrieve posts that match this segmentation filter. (Only available on the Pro plan (and up)). Example: beta.
ignore_filtersboolean- If true, all posts will be retrieved, ignoring any segmentation they may have. This parameter should only be used for requests sent from the backend. [In order to user this parameter, the API key should have the 'Read posts (ignore filters)' permission enabled.]. Example: true.
ignore_request_detailsboolean- Whether request-specific details should be ignored (this includes IP, browser/OS and geolocation details). Useful when sending requests from your backend, where the request's details aren't representative of the end user. Example: true.
languagestring- Retrieve posts with translations in this language. The language must follow the ISO-639 two-letter code format. (Only available on the Starter plan (and up)). Example: en.
mark_as_readboolean- Whether to mark the posts retrieved as 'read' for the specified user. By default, posts are marked as read and not retrieved again in subsequent calls. Example: true.
max_resultsinteger- Maximum number of items to return per page (Beamer returns at most 10). Example: 10.
pageinteger- Page number to return, combined with max_results, starting at 1. Example: 1.
save_viewsboolean- Whether to save views for the posts retrieved (for Analytics). If unspecified, views are saved. Example: true.
traceable_linksboolean- Whether links in the post should be converted to a traceable format (both the CTA and links within the content). If true, the opened URL will be tracked and record a 'click' entry in your Analytics. Example: true.
user_emailstring- Email of the user viewing these posts (for Analytics). Example: jane@example.com.
user_first_namestring- First name of the user viewing these posts (for Analytics). Example: Jane.
user_idstring- ID of the user viewing these posts (for Analytics). If single-user posts are enabled, posts with a matching userId will be retrieved. (Only available on the Scale plan) If multi-device synchronization is enabled, the dateFrom parameter will be overridden by this user's last date of viewing your feed - if any. dateFrom can be omitted in this case. (Only available on the Pro plan (and up)). Example: user_123.
user_last_namestring- Last name of the user viewing these posts (for Analytics). Example: Doe.
beamer_user_createCreate an end user in Beamer Analytics so posts and NPS can be targeted to them.WriteCreate User
Create an end user in Beamer Analytics so posts and NPS can be targeted to them. Returns the created user. user_id and user_email are required.
Inputs
user_emailstringrequired- Email for this user. Example: jane@example.com.
user_idstringrequired- Unique identifier for this user. Example: user_123.
browserstring- Browser from where this user accessed. Example: Chrome.
citystring- City from where this user accessed. Example: Lisbon.
countrystring- Country from where this user accessed. Example: PT.
filterstring- Segmentation filter(s) for this user, separated by semicolons. Example: beta;admin.
ipstring- IP from where this user accessed. Example: 203.0.113.7.
languagestring- Language for this user. The language must follow the ISO-639 two-letter code format. Example: ["en"]
latitudestring- Latitude from where this user accessed. Example: 38.7223.
longitudestring- Longitude from where this user accessed. Example: -9.1393.
osstring- Operating system from where this user accessed. Example: macOS.
user_first_namestring- First name for this user. Example: Jane.
user_last_namestring- Last name for this user. Example: Doe.
beamer_users_updateUpdate the Beamer Analytics users that match a user ID, Beamer ID or email.WriteUpdate Users
Update the Beamer Analytics users that match a user ID, Beamer ID or email. Returns the updated users. Set match_user_id, match_beamer_id or match_user_email to choose the users; the other fields are the new values.
- Idempotent
Inputs
browserstring- Browser from where this user accessed. Example: Chrome.
citystring- City from where this user accessed. Example: Lisbon.
countrystring- Country from where this user accessed. Example: PT.
filterstring- Segmentation filter(s) for this user, separated by semicolons. Example: beta;admin.
ipstring- IP from where this user accessed. Example: 203.0.113.7.
languagestring- Language for this user. The language must follow the ISO-639 two-letter code format. Example: ["en"]
latitudestring- Latitude from where this user accessed. Example: 38.7223.
longitudestring- Longitude from where this user accessed. Example: -9.1393.
match_beamer_idstring- Update the user with this Beamer-generated ID. Example: 84391274.
match_user_emailstring- Update the users with this email. Example: jane@example.com.
match_user_idstring- Update the users with this user ID. Example: user_123.
osstring- Operating system from where this user accessed. Example: macOS.
user_emailstring- New email. Example: jane@example.com.
user_first_namestring- First name for this user. Example: Jane.
user_idstring- New user ID. Example: user_123.
user_last_namestring- Last name for this user. Example: Doe.
beamer_feature_request_comment_deleteDelete a comment from a feature request.DestructiveDelete Feature Request Comment
Delete a comment from a feature request. Returns an empty success response. This cannot be undone.
- Idempotent
Inputs
comment_idintegerrequired- ID of the comment, from the matching comments list tool. Example: 7654321.
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
beamer_feature_request_deleteDelete a feature request with its votes and comments.DestructiveDelete Feature Request
Delete a feature request with its votes and comments. Returns an empty success response. This cannot be undone.
- Idempotent
Inputs
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
beamer_feature_request_vote_deleteRemove a vote from a feature request.DestructiveDelete Feature Request Vote
Remove a vote from a feature request. Returns an empty success response. This cannot be undone.
- Idempotent
Inputs
feature_request_idintegerrequired- ID of the feature request, from beamer_feature_requests_list. Example: 98765.
vote_idintegerrequired- ID of the vote, from beamer_feature_request_votes_list. Example: 112233.
beamer_post_comment_deleteDelete a comment from a changelog post.DestructiveDelete Post Comment
Delete a comment from a changelog post. Returns an empty success response. This cannot be undone.
- Idempotent
Inputs
comment_idintegerrequired- ID of the comment, from the matching comments list tool. Example: 7654321.
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
beamer_post_deleteDelete a changelog post with its comments and reactions.DestructiveDelete Post
Delete a changelog post with its comments and reactions. Returns an empty success response. This cannot be undone; to hide a post instead, set archive=true with beamer_post_update.
- Idempotent
Inputs
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
beamer_post_reaction_deleteDelete a reaction from a changelog post.DestructiveDelete Post Reaction
Delete a reaction from a changelog post. Returns an empty success response. This cannot be undone.
- Idempotent
Inputs
post_idintegerrequired- ID of the post, from beamer_posts_list. Example: 1234567.
reaction_idintegerrequired- ID of the reaction, from beamer_post_reactions_list. Example: 456789.
beamer_privacy_user_data_deletePermanently delete all data Beamer holds about an end user, for privacy requests such as GDPR erasure.DestructiveDelete User Data (Privacy)
Permanently delete all data Beamer holds about an end user, for privacy requests such as GDPR erasure. Returns a confirmation. Identify the user with user_id, beamer_id or user_email. This cannot be undone.
- Idempotent
Inputs
beamer_idstring- Beamer generated ID of the user to delete. Multiple IDs can be passed in, separated by semicolons (;). Example: 84391274.
user_emailstring- Email of the user to delete. Multiple emails can be passed in, separated by semicolons (;). Example: jane@example.com.
user_idstring- ID of the user to delete (as defined in the embedded script's user_id parameter). Example: user_123.
beamer_team_member_removeRemove a member from your Beamer team.DestructiveRemove Team Member
Remove a member from your Beamer team. Returns a confirmation. They lose access to the Beamer dashboard.
- Idempotent
Inputs
emailstringrequired- Email address of the team member to remove. Example: teammate@example.com.
beamer_users_deletePermanently delete the Beamer Analytics users that match a user ID, Beamer ID or email.DestructiveDelete Users
Permanently delete the Beamer Analytics users that match a user ID, Beamer ID or email. Returns a confirmation. At least one identifier is required. This cannot be undone.
- Idempotent
Inputs
beamer_idstring- Beamer generated ID of the user to delete. Multiple IDs can be passed in, separated by semicolons (;). Example: 84391274.
user_emailstring- Email of the user to delete. Multiple emails can be passed in, separated by semicolons (;). Example: jane@example.com.
user_idstring- ID of the user to delete (as defined in the embedded script's user_id parameter). Multiple IDs can be passed in, separated by semicolons (;). Example: user_123.
No tools match.