KosmoKrator

productivity

Braze Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Braze KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.braze.*. Use lua_read_doc("integrations.braze") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Braze workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.braze.api_get({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("braze"))' --json
kosmo integrations:lua --eval 'print(docs.read("braze.api_get"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local braze = app.integrations.braze
local result = braze.api_get({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.braze, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.braze.default.* or app.integrations.braze.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Braze, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Braze Integration

Namespace: app.integrations.braze

Use this integration to work with the Braze REST API from an agent. Configure a Braze REST API key and the REST endpoint for the workspace region, such as https://rest.iad-01.braze.com or https://rest.fra-01.braze.eu.

Common Workflows

Track user data

local result = app.integrations.braze.track_users({
  payload = {
    attributes = {
      {
        external_id = "user_123",
        email = "person@example.test",
        first_name = "Ada"
      }
    },
    events = {
      {
        external_id = "user_123",
        name = "trial_started",
        time = "2026-05-07T10:00:00Z"
      }
    }
  }
})

Trigger an API campaign

local result = app.integrations.braze.trigger_campaign_send({
  payload = {
    campaign_id = "campaign-id",
    recipients = {
      {
        external_user_id = "user_123",
        trigger_properties = {
          plan = "pro"
        }
      }
    }
  }
})

Export campaign analytics

local result = app.integrations.braze.get_campaign_analytics({
  campaign_id = "campaign-id",
  length = 7,
  ending_at = "2026-05-07T00:00:00Z"
})

Manage catalog items

local result = app.integrations.braze.create_catalog_item({
  catalog_name = "products",
  item_id = "sku_123",
  payload = {
    item = {
      name = "Demo product",
      price = 29
    }
  }
})

Coverage Notes

Focused tools cover Braze catalogs, Cloud Data Ingestion syncs, email lists and statuses, campaign and Canvas exports, analytics, purchases, segments, messaging and scheduling, preference centers, SCIM dashboard users, SDK authentication keys, SMS and subscription groups, content blocks, email templates, user lifecycle endpoints, and media upload.

Most write tools accept a payload object that maps directly to the Braze request body. Read tools expose common query parameters directly and also support the raw api_get, api_post, api_put, api_patch, and api_delete escape hatches when Braze adds a new endpoint before this package has a focused wrapper.

Braze REST API keys are permission-scoped. A valid key can still receive 403 errors for endpoints that were not enabled when the key was created.

Raw agent markdown 
# Braze Integration

Namespace: `app.integrations.braze`

Use this integration to work with the Braze REST API from an agent. Configure a Braze REST API key and the REST endpoint for the workspace region, such as `https://rest.iad-01.braze.com` or `https://rest.fra-01.braze.eu`.

## Common Workflows

### Track user data

```lua
local result = app.integrations.braze.track_users({
  payload = {
    attributes = {
      {
        external_id = "user_123",
        email = "person@example.test",
        first_name = "Ada"
      }
    },
    events = {
      {
        external_id = "user_123",
        name = "trial_started",
        time = "2026-05-07T10:00:00Z"
      }
    }
  }
})
```

### Trigger an API campaign

```lua
local result = app.integrations.braze.trigger_campaign_send({
  payload = {
    campaign_id = "campaign-id",
    recipients = {
      {
        external_user_id = "user_123",
        trigger_properties = {
          plan = "pro"
        }
      }
    }
  }
})
```

### Export campaign analytics

```lua
local result = app.integrations.braze.get_campaign_analytics({
  campaign_id = "campaign-id",
  length = 7,
  ending_at = "2026-05-07T00:00:00Z"
})
```

### Manage catalog items

```lua
local result = app.integrations.braze.create_catalog_item({
  catalog_name = "products",
  item_id = "sku_123",
  payload = {
    item = {
      name = "Demo product",
      price = 29
    }
  }
})
```

## Coverage Notes

Focused tools cover Braze catalogs, Cloud Data Ingestion syncs, email lists and statuses, campaign and Canvas exports, analytics, purchases, segments, messaging and scheduling, preference centers, SCIM dashboard users, SDK authentication keys, SMS and subscription groups, content blocks, email templates, user lifecycle endpoints, and media upload.

Most write tools accept a `payload` object that maps directly to the Braze request body. Read tools expose common query parameters directly and also support the raw `api_get`, `api_post`, `api_put`, `api_patch`, and `api_delete` escape hatches when Braze adds a new endpoint before this package has a focused wrapper.

Braze REST API keys are permission-scoped. A valid key can still receive `403` errors for endpoints that were not enabled when the key was created.
Metadata-derived Lua example 
local result = app.integrations.braze.api_get({})
print(result)

Functions

api_get Read

Call any Braze REST API GET endpoint with query parameters.

Lua path
app.integrations.braze.api_get
Full name
braze.braze_api_get
ParameterTypeRequiredDescription
No parameters.
api_post Write

Call any Braze REST API POST endpoint with a JSON payload.

Lua path
app.integrations.braze.api_post
Full name
braze.braze_api_post
ParameterTypeRequiredDescription
No parameters.
api_put Write

Call any Braze REST API PUT endpoint with a JSON payload.

Lua path
app.integrations.braze.api_put
Full name
braze.braze_api_put
ParameterTypeRequiredDescription
No parameters.
api_patch Write

Call any Braze REST API PATCH endpoint with a JSON payload.

Lua path
app.integrations.braze.api_patch
Full name
braze.braze_api_patch
ParameterTypeRequiredDescription
No parameters.
api_delete Write

Call any Braze REST API DELETE endpoint with query parameters.

Lua path
app.integrations.braze.api_delete
Full name
braze.braze_api_delete
ParameterTypeRequiredDescription
No parameters.
list_catalogs Read

List Braze catalogs.

Lua path
app.integrations.braze.list_catalogs
Full name
braze.braze_list_catalogs
ParameterTypeRequiredDescription
No parameters.
create_catalog Write

Create a Braze catalog.

Lua path
app.integrations.braze.create_catalog
Full name
braze.braze_create_catalog
ParameterTypeRequiredDescription
No parameters.
delete_catalog Write

Delete a Braze catalog.

Lua path
app.integrations.braze.delete_catalog
Full name
braze.braze_delete_catalog
ParameterTypeRequiredDescription
No parameters.
list_catalog_items Read

List items in a Braze catalog.

Lua path
app.integrations.braze.list_catalog_items
Full name
braze.braze_list_catalog_items
ParameterTypeRequiredDescription
No parameters.
get_catalog_item Read

Get a single Braze catalog item.

Lua path
app.integrations.braze.get_catalog_item
Full name
braze.braze_get_catalog_item
ParameterTypeRequiredDescription
No parameters.
create_catalog_item Write

Create a Braze catalog item.

Lua path
app.integrations.braze.create_catalog_item
Full name
braze.braze_create_catalog_item
ParameterTypeRequiredDescription
No parameters.
replace_catalog_item Write

Replace a Braze catalog item.

Lua path
app.integrations.braze.replace_catalog_item
Full name
braze.braze_replace_catalog_item
ParameterTypeRequiredDescription
No parameters.
edit_catalog_item Write

Edit a Braze catalog item.

Lua path
app.integrations.braze.edit_catalog_item
Full name
braze.braze_edit_catalog_item
ParameterTypeRequiredDescription
No parameters.
delete_catalog_item Write

Delete a Braze catalog item.

Lua path
app.integrations.braze.delete_catalog_item
Full name
braze.braze_delete_catalog_item
ParameterTypeRequiredDescription
No parameters.
create_catalog_items Write

Create multiple Braze catalog items asynchronously.

Lua path
app.integrations.braze.create_catalog_items
Full name
braze.braze_create_catalog_items
ParameterTypeRequiredDescription
No parameters.
replace_catalog_items Write

Replace multiple Braze catalog items asynchronously.

Lua path
app.integrations.braze.replace_catalog_items
Full name
braze.braze_replace_catalog_items
ParameterTypeRequiredDescription
No parameters.
edit_catalog_items Write

Edit multiple Braze catalog items asynchronously.

Lua path
app.integrations.braze.edit_catalog_items
Full name
braze.braze_edit_catalog_items
ParameterTypeRequiredDescription
No parameters.
delete_catalog_items Write

Delete multiple Braze catalog items asynchronously.

Lua path
app.integrations.braze.delete_catalog_items
Full name
braze.braze_delete_catalog_items
ParameterTypeRequiredDescription
No parameters.
create_catalog_fields Write

Create Braze catalog fields.

Lua path
app.integrations.braze.create_catalog_fields
Full name
braze.braze_create_catalog_fields
ParameterTypeRequiredDescription
No parameters.
delete_catalog_field Write

Delete a Braze catalog field.

Lua path
app.integrations.braze.delete_catalog_field
Full name
braze.braze_delete_catalog_field
ParameterTypeRequiredDescription
No parameters.
create_catalog_selection Write

Create a Braze catalog selection.

Lua path
app.integrations.braze.create_catalog_selection
Full name
braze.braze_create_catalog_selection
ParameterTypeRequiredDescription
No parameters.
delete_catalog_selection Write

Delete a Braze catalog selection.

Lua path
app.integrations.braze.delete_catalog_selection
Full name
braze.braze_delete_catalog_selection
ParameterTypeRequiredDescription
No parameters.
list_cdi_integrations Read

List Braze Cloud Data Ingestion integrations.

Lua path
app.integrations.braze.list_cdi_integrations
Full name
braze.braze_list_cdi_integrations
ParameterTypeRequiredDescription
No parameters.
get_cdi_sync_status Read

Get Cloud Data Ingestion sync status.

Lua path
app.integrations.braze.get_cdi_sync_status
Full name
braze.braze_get_cdi_sync_status
ParameterTypeRequiredDescription
No parameters.
trigger_cdi_sync Write

Trigger a Cloud Data Ingestion sync.

Lua path
app.integrations.braze.trigger_cdi_sync
Full name
braze.braze_trigger_cdi_sync
ParameterTypeRequiredDescription
No parameters.
list_hard_bounces Read

Query hard bounced email addresses.

Lua path
app.integrations.braze.list_hard_bounces
Full name
braze.braze_list_hard_bounces
ParameterTypeRequiredDescription
No parameters.
list_unsubscribes Read

Query unsubscribed email addresses.

Lua path
app.integrations.braze.list_unsubscribes
Full name
braze.braze_list_unsubscribes
ParameterTypeRequiredDescription
No parameters.
change_email_status Write

Change an email subscription status.

Lua path
app.integrations.braze.change_email_status
Full name
braze.braze_change_email_status
ParameterTypeRequiredDescription
No parameters.
remove_hard_bounces Write

Remove email addresses from the hard bounce list.

Lua path
app.integrations.braze.remove_hard_bounces
Full name
braze.braze_remove_hard_bounces
ParameterTypeRequiredDescription
No parameters.
remove_spam_emails Write

Remove email addresses from the spam list.

Lua path
app.integrations.braze.remove_spam_emails
Full name
braze.braze_remove_spam_emails
ParameterTypeRequiredDescription
No parameters.
blocklist_emails Write

Blocklist email addresses in Braze.

Lua path
app.integrations.braze.blocklist_emails
Full name
braze.braze_blocklist_emails
ParameterTypeRequiredDescription
No parameters.
list_campaigns Read

List Braze campaigns.

Lua path
app.integrations.braze.list_campaigns
Full name
braze.braze_list_campaigns
ParameterTypeRequiredDescription
No parameters.
get_campaign Read

Get Braze campaign details.

Lua path
app.integrations.braze.get_campaign
Full name
braze.braze_get_campaign
ParameterTypeRequiredDescription
No parameters.
get_campaign_analytics Read

Export campaign analytics over a time range.

Lua path
app.integrations.braze.get_campaign_analytics
Full name
braze.braze_get_campaign_analytics
ParameterTypeRequiredDescription
No parameters.
get_send_analytics Read

Export send analytics over a time range.

Lua path
app.integrations.braze.get_send_analytics
Full name
braze.braze_get_send_analytics
ParameterTypeRequiredDescription
No parameters.
get_campaign_url_info Read

Get URL details for a campaign message variation.

Lua path
app.integrations.braze.get_campaign_url_info
Full name
braze.braze_get_campaign_url_info
ParameterTypeRequiredDescription
No parameters.
duplicate_campaign Write

Duplicate a Braze campaign.

Lua path
app.integrations.braze.duplicate_campaign
Full name
braze.braze_duplicate_campaign
ParameterTypeRequiredDescription
No parameters.
list_canvases Read

List Braze Canvases.

Lua path
app.integrations.braze.list_canvases
Full name
braze.braze_list_canvases
ParameterTypeRequiredDescription
No parameters.
get_canvas Read

Get Braze Canvas details.

Lua path
app.integrations.braze.get_canvas
Full name
braze.braze_get_canvas
ParameterTypeRequiredDescription
No parameters.
get_canvas_analytics Read

Export Canvas analytics over a time range.

Lua path
app.integrations.braze.get_canvas_analytics
Full name
braze.braze_get_canvas_analytics
ParameterTypeRequiredDescription
No parameters.
get_canvas_summary Read

Export Canvas summary analytics.

Lua path
app.integrations.braze.get_canvas_summary
Full name
braze.braze_get_canvas_summary
ParameterTypeRequiredDescription
No parameters.
get_canvas_url_info Read

Get URL details for a Canvas step message variation.

Lua path
app.integrations.braze.get_canvas_url_info
Full name
braze.braze_get_canvas_url_info
ParameterTypeRequiredDescription
No parameters.
duplicate_canvas Write

Duplicate a Braze Canvas.

Lua path
app.integrations.braze.duplicate_canvas
Full name
braze.braze_duplicate_canvas
ParameterTypeRequiredDescription
No parameters.
list_events Read

List custom events.

Lua path
app.integrations.braze.list_events
Full name
braze.braze_list_events
ParameterTypeRequiredDescription
No parameters.
get_event_analytics Read

Export custom event analytics.

Lua path
app.integrations.braze.get_event_analytics
Full name
braze.braze_get_event_analytics
ParameterTypeRequiredDescription
No parameters.
list_custom_attributes Read

Export custom attributes.

Lua path
app.integrations.braze.list_custom_attributes
Full name
braze.braze_list_custom_attributes
ParameterTypeRequiredDescription
No parameters.
get_sessions_analytics Read

Export app sessions by time.

Lua path
app.integrations.braze.get_sessions_analytics
Full name
braze.braze_get_sessions_analytics
ParameterTypeRequiredDescription
No parameters.
get_daily_active_users Read

Export daily active users.

Lua path
app.integrations.braze.get_daily_active_users
Full name
braze.braze_get_daily_active_users
ParameterTypeRequiredDescription
No parameters.
get_monthly_active_users Read

Export monthly active users.

Lua path
app.integrations.braze.get_monthly_active_users
Full name
braze.braze_get_monthly_active_users
ParameterTypeRequiredDescription
No parameters.
get_new_users Read

Export daily new users.

Lua path
app.integrations.braze.get_new_users
Full name
braze.braze_get_new_users
ParameterTypeRequiredDescription
No parameters.
get_uninstalls Read

Export app uninstalls.

Lua path
app.integrations.braze.get_uninstalls
Full name
braze.braze_get_uninstalls
ParameterTypeRequiredDescription
No parameters.
list_products Read

Export product IDs purchased in the app.

Lua path
app.integrations.braze.list_products
Full name
braze.braze_list_products
ParameterTypeRequiredDescription
No parameters.
get_revenue_analytics Read

Export revenue data.

Lua path
app.integrations.braze.get_revenue_analytics
Full name
braze.braze_get_revenue_analytics
ParameterTypeRequiredDescription
No parameters.
get_purchase_quantity_analytics Read

Export number of purchases.

Lua path
app.integrations.braze.get_purchase_quantity_analytics
Full name
braze.braze_get_purchase_quantity_analytics
ParameterTypeRequiredDescription
No parameters.
list_segments Read

List Braze segments.

Lua path
app.integrations.braze.list_segments
Full name
braze.braze_list_segments
ParameterTypeRequiredDescription
No parameters.
get_segment Read

Get Braze segment details.

Lua path
app.integrations.braze.get_segment
Full name
braze.braze_get_segment
ParameterTypeRequiredDescription
No parameters.
get_segment_analytics Read

Export segment analytics.

Lua path
app.integrations.braze.get_segment_analytics
Full name
braze.braze_get_segment_analytics
ParameterTypeRequiredDescription
No parameters.
cancel_segment_export Write

Cancel user exports by segment.

Lua path
app.integrations.braze.cancel_segment_export
Full name
braze.braze_cancel_segment_export
ParameterTypeRequiredDescription
No parameters.
create_send_ids Write

Create send IDs for message blast tracking.

Lua path
app.integrations.braze.create_send_ids
Full name
braze.braze_create_send_ids
ParameterTypeRequiredDescription
No parameters.
send_messages Write

Send immediate API-only messages.

Lua path
app.integrations.braze.send_messages
Full name
braze.braze_send_messages
ParameterTypeRequiredDescription
No parameters.
send_transactional_email Write

Send a transactional email using API-triggered delivery.

Lua path
app.integrations.braze.send_transactional_email
Full name
braze.braze_send_transactional_email
ParameterTypeRequiredDescription
No parameters.
trigger_campaign_send Write

Trigger an API-triggered Braze campaign.

Lua path
app.integrations.braze.trigger_campaign_send
Full name
braze.braze_trigger_campaign_send
ParameterTypeRequiredDescription
No parameters.
trigger_canvas_send Write

Trigger an API-triggered Braze Canvas.

Lua path
app.integrations.braze.trigger_canvas_send
Full name
braze.braze_trigger_canvas_send
ParameterTypeRequiredDescription
No parameters.
list_scheduled_broadcasts Read

List upcoming scheduled campaigns and Canvases.

Lua path
app.integrations.braze.list_scheduled_broadcasts
Full name
braze.braze_list_scheduled_broadcasts
ParameterTypeRequiredDescription
No parameters.
create_scheduled_messages Write

Create scheduled messages.

Lua path
app.integrations.braze.create_scheduled_messages
Full name
braze.braze_create_scheduled_messages
ParameterTypeRequiredDescription
No parameters.
update_scheduled_messages Write

Update scheduled messages.

Lua path
app.integrations.braze.update_scheduled_messages
Full name
braze.braze_update_scheduled_messages
ParameterTypeRequiredDescription
No parameters.
delete_scheduled_messages Write

Delete scheduled messages.

Lua path
app.integrations.braze.delete_scheduled_messages
Full name
braze.braze_delete_scheduled_messages
ParameterTypeRequiredDescription
No parameters.
schedule_campaign_trigger Write

Schedule an API-triggered campaign.

Lua path
app.integrations.braze.schedule_campaign_trigger
Full name
braze.braze_schedule_campaign_trigger
ParameterTypeRequiredDescription
No parameters.
update_campaign_trigger_schedule Write

Update a scheduled API-triggered campaign.

Lua path
app.integrations.braze.update_campaign_trigger_schedule
Full name
braze.braze_update_campaign_trigger_schedule
ParameterTypeRequiredDescription
No parameters.
delete_campaign_trigger_schedule Write

Delete a scheduled API-triggered campaign.

Lua path
app.integrations.braze.delete_campaign_trigger_schedule
Full name
braze.braze_delete_campaign_trigger_schedule
ParameterTypeRequiredDescription
No parameters.
schedule_canvas_trigger Write

Schedule an API-triggered Canvas.

Lua path
app.integrations.braze.schedule_canvas_trigger
Full name
braze.braze_schedule_canvas_trigger
ParameterTypeRequiredDescription
No parameters.
update_canvas_trigger_schedule Write

Update a scheduled API-triggered Canvas.

Lua path
app.integrations.braze.update_canvas_trigger_schedule
Full name
braze.braze_update_canvas_trigger_schedule
ParameterTypeRequiredDescription
No parameters.
delete_canvas_trigger_schedule Write

Delete a scheduled API-triggered Canvas.

Lua path
app.integrations.braze.delete_canvas_trigger_schedule
Full name
braze.braze_delete_canvas_trigger_schedule
ParameterTypeRequiredDescription
No parameters.
start_live_activity Write

Start an iOS Live Activity.

Lua path
app.integrations.braze.start_live_activity
Full name
braze.braze_start_live_activity
ParameterTypeRequiredDescription
No parameters.
update_live_activity Write

Update an iOS Live Activity.

Lua path
app.integrations.braze.update_live_activity
Full name
braze.braze_update_live_activity
ParameterTypeRequiredDescription
No parameters.
list_preference_centers Read

List Braze preference centers.

Lua path
app.integrations.braze.list_preference_centers
Full name
braze.braze_list_preference_centers
ParameterTypeRequiredDescription
No parameters.
get_preference_center Read

Get a Braze preference center.

Lua path
app.integrations.braze.get_preference_center
Full name
braze.braze_get_preference_center
ParameterTypeRequiredDescription
No parameters.
generate_preference_center_url Read

Generate a preference center URL for a user.

Lua path
app.integrations.braze.generate_preference_center_url
Full name
braze.braze_generate_preference_center_url
ParameterTypeRequiredDescription
No parameters.
create_preference_center Write

Create a Braze preference center.

Lua path
app.integrations.braze.create_preference_center
Full name
braze.braze_create_preference_center
ParameterTypeRequiredDescription
No parameters.
update_preference_center Write

Update a Braze preference center.

Lua path
app.integrations.braze.update_preference_center
Full name
braze.braze_update_preference_center
ParameterTypeRequiredDescription
No parameters.
search_scim_users Read

Search Braze dashboard SCIM users.

Lua path
app.integrations.braze.search_scim_users
Full name
braze.braze_search_scim_users
ParameterTypeRequiredDescription
No parameters.
get_scim_user Read

Look up a Braze dashboard SCIM user.

Lua path
app.integrations.braze.get_scim_user
Full name
braze.braze_get_scim_user
ParameterTypeRequiredDescription
No parameters.
create_scim_user Write

Create a Braze dashboard SCIM user.

Lua path
app.integrations.braze.create_scim_user
Full name
braze.braze_create_scim_user
ParameterTypeRequiredDescription
No parameters.
update_scim_user Write

Update a Braze dashboard SCIM user.

Lua path
app.integrations.braze.update_scim_user
Full name
braze.braze_update_scim_user
ParameterTypeRequiredDescription
No parameters.
delete_scim_user Write

Remove a Braze dashboard SCIM user.

Lua path
app.integrations.braze.delete_scim_user
Full name
braze.braze_delete_scim_user
ParameterTypeRequiredDescription
No parameters.
create_sdk_authentication_key Write

Create an SDK authentication key.

Lua path
app.integrations.braze.create_sdk_authentication_key
Full name
braze.braze_create_sdk_authentication_key
ParameterTypeRequiredDescription
No parameters.
list_sdk_authentication_keys Read

List SDK authentication keys.

Lua path
app.integrations.braze.list_sdk_authentication_keys
Full name
braze.braze_list_sdk_authentication_keys
ParameterTypeRequiredDescription
No parameters.
set_primary_sdk_authentication_key Write

Set the primary SDK authentication key.

Lua path
app.integrations.braze.set_primary_sdk_authentication_key
Full name
braze.braze_set_primary_sdk_authentication_key
ParameterTypeRequiredDescription
No parameters.
delete_sdk_authentication_key Write

Delete an SDK authentication key.

Lua path
app.integrations.braze.delete_sdk_authentication_key
Full name
braze.braze_delete_sdk_authentication_key
ParameterTypeRequiredDescription
No parameters.
list_invalid_phone_numbers Read

Query invalid phone numbers.

Lua path
app.integrations.braze.list_invalid_phone_numbers
Full name
braze.braze_list_invalid_phone_numbers
ParameterTypeRequiredDescription
No parameters.
remove_invalid_phone_numbers Write

Remove invalid phone number flags.

Lua path
app.integrations.braze.remove_invalid_phone_numbers
Full name
braze.braze_remove_invalid_phone_numbers
ParameterTypeRequiredDescription
No parameters.
get_subscription_group_status Read

List users subscription group status.

Lua path
app.integrations.braze.get_subscription_group_status
Full name
braze.braze_get_subscription_group_status
ParameterTypeRequiredDescription
No parameters.
list_user_subscription_groups Read

List subscription groups for users.

Lua path
app.integrations.braze.list_user_subscription_groups
Full name
braze.braze_list_user_subscription_groups
ParameterTypeRequiredDescription
No parameters.
set_subscription_group_status Write

Update users subscription group status.

Lua path
app.integrations.braze.set_subscription_group_status
Full name
braze.braze_set_subscription_group_status
ParameterTypeRequiredDescription
No parameters.
set_subscription_group_status_v2 Write

Update users subscription group status using v2 semantics.

Lua path
app.integrations.braze.set_subscription_group_status_v2
Full name
braze.braze_set_subscription_group_status_v2
ParameterTypeRequiredDescription
No parameters.
list_content_blocks Read

List available content blocks.

Lua path
app.integrations.braze.list_content_blocks
Full name
braze.braze_list_content_blocks
ParameterTypeRequiredDescription
No parameters.
get_content_block Read

Get Content Block information.

Lua path
app.integrations.braze.get_content_block
Full name
braze.braze_get_content_block
ParameterTypeRequiredDescription
No parameters.
create_content_block Write

Create a Content Block.

Lua path
app.integrations.braze.create_content_block
Full name
braze.braze_create_content_block
ParameterTypeRequiredDescription
No parameters.
update_content_block Write

Update a Content Block.

Lua path
app.integrations.braze.update_content_block
Full name
braze.braze_update_content_block
ParameterTypeRequiredDescription
No parameters.
list_email_templates Read

List email templates.

Lua path
app.integrations.braze.list_email_templates
Full name
braze.braze_list_email_templates
ParameterTypeRequiredDescription
No parameters.
get_email_template Read

Get email template information.

Lua path
app.integrations.braze.get_email_template
Full name
braze.braze_get_email_template
ParameterTypeRequiredDescription
No parameters.
create_email_template Write

Create an email template.

Lua path
app.integrations.braze.create_email_template
Full name
braze.braze_create_email_template
ParameterTypeRequiredDescription
No parameters.
update_email_template Write

Update an email template.

Lua path
app.integrations.braze.update_email_template
Full name
braze.braze_update_email_template
ParameterTypeRequiredDescription
No parameters.
create_user_alias Write

Create a new user alias.

Lua path
app.integrations.braze.create_user_alias
Full name
braze.braze_create_user_alias
ParameterTypeRequiredDescription
No parameters.
update_user_alias Write

Update a user alias.

Lua path
app.integrations.braze.update_user_alias
Full name
braze.braze_update_user_alias
ParameterTypeRequiredDescription
No parameters.
identify_users Write

Identify alias-only users with external IDs.

Lua path
app.integrations.braze.identify_users
Full name
braze.braze_identify_users
ParameterTypeRequiredDescription
No parameters.
track_users Write

Create or update users, custom events, and purchases.

Lua path
app.integrations.braze.track_users
Full name
braze.braze_track_users
ParameterTypeRequiredDescription
No parameters.
track_users_bulk Write

Create or update users in bulk.

Lua path
app.integrations.braze.track_users_bulk
Full name
braze.braze_track_users_bulk
ParameterTypeRequiredDescription
No parameters.
track_users_sync Write

Synchronously create or update users.

Lua path
app.integrations.braze.track_users_sync
Full name
braze.braze_track_users_sync
ParameterTypeRequiredDescription
No parameters.
delete_users Write

Delete Braze users.

Lua path
app.integrations.braze.delete_users
Full name
braze.braze_delete_users
ParameterTypeRequiredDescription
No parameters.
merge_users Write

Merge Braze users.

Lua path
app.integrations.braze.merge_users
Full name
braze.braze_merge_users
ParameterTypeRequiredDescription
No parameters.
rename_external_id Write

Rename a user external ID.

Lua path
app.integrations.braze.rename_external_id
Full name
braze.braze_rename_external_id
ParameterTypeRequiredDescription
No parameters.
remove_external_id Write

Remove user external IDs.

Lua path
app.integrations.braze.remove_external_id
Full name
braze.braze_remove_external_id
ParameterTypeRequiredDescription
No parameters.
export_users_by_ids Read

Export user profiles by identifiers.

Lua path
app.integrations.braze.export_users_by_ids
Full name
braze.braze_export_users_by_ids
ParameterTypeRequiredDescription
No parameters.
export_users_by_segment Read

Export user profiles by segment.

Lua path
app.integrations.braze.export_users_by_segment
Full name
braze.braze_export_users_by_segment
ParameterTypeRequiredDescription
No parameters.
export_global_control_group_users Read

Export global control group users.

Lua path
app.integrations.braze.export_global_control_group_users
Full name
braze.braze_export_global_control_group_users
ParameterTypeRequiredDescription
No parameters.
upload_media_asset Write

Upload an asset to the Braze media library.

Lua path
app.integrations.braze.upload_media_asset
Full name
braze.braze_upload_media_asset
ParameterTypeRequiredDescription
No parameters.