Braze
Send personalized messages across email, push, SMS, and in-app with Braze
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 95 actions:
| Action | Purpose | Parameters |
|---|---|---|
| delete_catalogs_by_catalog_name | Use this endpoint to delete a catalog. | catalog_name (string) Content-Type (string) Authorization (string) |
| get_catalogs | Use this endpoint to return a list of catalogs in a workspace. | Content-Type (string) Authorization (string) |
| post_catalogs | Use this endpoint to create a catalog. | Content-Type (string) Authorization (string) data: { . catalogs (array) } (object) required |
| delete_catalogs_by_catalog_name_items | Use this endpoint to delete multiple items in your catalog. | catalog_name (string) Content-Type (string) Authorization (string) data: { . items (array) } (object) required |
| patch_catalogs_by_catalog_name_items | Use this endpoint to delete multiple items in your catalog. | catalog_name (string) Content-Type (string) Authorization (string) data: { . items (array) } (object) required |
| post_catalogs_by_catalog_name_items | Use this endpoint to create multiple items in your catalog. | catalog_name (string) Content-Type (string) Authorization (string) data: { . items (array) } (object) required |
| put_catalogs_by_catalog_name_items | Use this endpoint to update multiple items in your catalog. | catalog_name (string) Content-Type (string) Authorization (string) data: { . items (array) } (object) required |
| get_catalogs_by_catalog_name_items | Use this endpoint to return multiple catalog items and their content. | catalog_name (string) Content-Type (string) Authorization (string) |
| delete_catalogs_by_catalog_name_items_by_item_id | Use this endpoint to delete an item in your catalog. | catalog_name (string) item_id (string) Content-Type (string) Authorization (string) |
| get_catalogs_by_catalog_name_items_by_item_id | Use this endpoint to return a catalog item and its content. | catalog_name (string) item_id (string) Content-Type (string) Authorization (string) |
| patch_catalogs_by_catalog_name_items_by_item_id | Use this endpoint to edit an item in your catalog. | catalog_name (string) item_id (string) Content-Type (string) Authorization (string) data: { . items (array) } (object) required |
| post_catalogs_by_catalog_name_items_by_item_id | Use this endpoint to create an item in your catalog. | catalog_name (string) item_id (string) Content-Type (string) Authorization (string) data: { . items (array) } (object) required |
| put_catalogs_by_catalog_name_items_by_item_id | Use this endpoint to update an item in your catalog. | catalog_name (string) item_id (string) Content-Type (string) Authorization (string) data: { . items (array) } (object) required |
| get_email_hard_bounces | Use this endpoint to pull a list of email addresses that have “hard bounced” your email messages within a certain time frame. | Authorization (string) start_date (string) end_date (string) limit (integer) offset (integer) email (string) |
| get_email_unsubscribes | Use this endpoint to return emails that have unsubscribed during the time period from start_date to end_date. | Authorization (string) start_date (string) end_date (string) limit (integer) offset (integer) sort_direction (string) email (string) |
| post_email_status | Use this endpoint to set the email subscription state for your users. Users can be opted_in, unsubscribed, or subscribed not specifically opted in or out. | Content-Type (string) Authorization (string) data: { . email (string) . subscription_state (string) } (object) required |
| post_email_bounce_remove | Use this endpoint to remove email addresses from your Braze bounce list and bounce list maintained by your email provider. | Content-Type (string) Authorization (string) data: { . email (string) } (object) required |
| post_email_spam_remove | Use this endpoint to remove email addresses from your Braze spam list and spam list maintained by your email provider. | Content-Type (string) Authorization (string) data: { . email (string) } (object) required |
| post_email_blocklist | Use this endpoint to unsubscribe a user from email and mark them as hard bounced. | Content-Type (string) Authorization (string) data: { . email (array) } (object) required |
| post_email_blacklist | Use this endpoint to unsubscribe a user from email and mark them as hard bounced. | Content-Type (string) Authorization (string) data: { . email (array) } (object) required |
| get_campaigns_data_series | Use this endpoint to retrieve a daily series of various stats for a campaign over time. | Authorization (string) campaign_id (string) length (integer) ending_at (string) |
| get_campaigns_details | Use this endpoint to retrieve relevant information on a specified campaign, which can be identified by the campaign_id. | Authorization (string) campaign_id (string) |
| get_campaigns_list | Use this endpoint to export a list of campaigns, each of which will include its name, campaign API identifier, whether it is an API campaign, and tags associated with the campaign. | Authorization (string) page (integer) include_archived (boolean) sort_direction (string) last_edit.timegt (string) |
| get_sends_data_series | Use this endpoint to retrieve a daily series of various stats for a tracked send_id for API campaigns. | Authorization (string) campaign_id (string) send_id (string) length (integer) ending_at (string) |
| get_canvas_data_series | Use this endpoint to export time series data for a Canvas. | Authorization (string) canvas_id (string) ending_at (string) starting_at (string) length (integer) include_variant_breakdown (boolean) include_step_breakdown (boolean) include_deleted_step_data (boolean) |
| get_canvas_data_summary | Use this endpoint to export rollups of time series data for a Canvas, providing a concise summary of a Canvas’ results. | Authorization (string) canvas_id (string) ending_at (string) starting_at (string) length (integer) include_variant_breakdown (boolean) include_step_breakdown (boolean) include_deleted_step_data (boolean) |
| get_canvas_details | Use this endpoint to export metadata about a Canvas, such as the name, time created, current status, and more. | Authorization (string) canvas_id (string) |
| get_canvas_list | Use this endpoint to export a list of Canvases, including the name, Canvas API identifier and associated tags. | Authorization (string) page (integer) include_archived (boolean) sort_direction (string) last_edit.timegt (string) |
| get_events_list | Use this endpoint to export a list of custom events that have been recorded for your app. The event names are returned in groups of 250, sorted alphabetically. | Authorization (string) page (integer) |
| get_events_data_series | Use this endpoint to retrieve a series of the number of occurrences of a custom event in your app over a designated time period. | Authorization (string) event (string) length (integer) unit (string) ending_at (string) app_id (string) segment_id (string) |
| get_kpi_new_users_data_series | Use this endpoint to retrieve a daily series of the total number of new users on each date. | Authorization (string) length (integer) ending_at (string) app_id (string) |
| get_kpi_dau_data_series | Use this endpoint to retrieve a daily series of the total number of unique active users on each date. | Authorization (string) length (integer) ending_at (string) app_id (string) |
| get_kpi_mau_data_series | Use this endpoint to retrieve a daily series of the total number of unique active users over a 30-day rolling window. | Authorization (string) length (integer) ending_at (string) app_id (string) |
| get_kpi_uninstalls_data_series | Use this endpoint to retrieve a daily series of the total number of uninstalls on each date. | Authorization (string) length (integer) ending_at (string) app_id (string) |
| get_feed_data_series | Use this endpoint to retrieve a daily series of engagement stats for a card over time. | Authorization (string) card_id (string) length (integer) unit (string) ending_at (string) |
| get_feed_details | Use this endpoint to retrieve relevant information on a card, which can be identified by the card_id. | Authorization (string) card_id (string) |
| get_feed_list | Use this endpoint to export a list of News Feed cards, each of which will include its name and card API identifier. | Authorization (string) page (integer) include_archived (boolean) sort_direction (string) |
| get_purchases_product_list | Use this endpoint to return a paginated lists of product IDs. | Authorization (string) page (integer) |
| get_purchases_quantity_series | Use this endpoint to return the total number of purchases in your app over a time range. | Authorization (string) ending_at (string) length (integer) unit (integer) app_id (string) product (string) |
| get_purchases_revenue_series | Use this endpoint to return the total money spent in your app over a time range. | Authorization (string) ending_at (string) length (integer) unit (integer) app_id (string) product (string) |
| get_segments_list | Use this endpoint to export a list of segments, each of which will include its name, Segment API identifier, and whether it has analytics tracking enabled. | Authorization (string) page (integer) sort_direction (string) |
| get_segments_data_series | Use this endpoint to retrieve a daily series of the estimated size of a segment over time. | Authorization (string) segment_id (string) length (integer) ending_at (string) |
| get_segments_details | Use this endpoint to retrieve relevant information on a segment, which can be identified by the segment_id. | Authorization (string) segment_id (string) |
| get_sessions_data_series | Use this endpoint to retrieve a series of the number of sessions for your app over a designated time period. | Authorization (string) length (integer) unit (string) ending_at (string) app_id (string) segment_id (string) |
| post_users_export_ids | Use this endpoint to export data from any user profile by specifying a user identifier. | Content-Type (string) Authorization (string) data: { . external_ids (array) . user_aliases (array) . device_id (string) . braze_id (string) . email_address (string) . phone (string) . fields_to_export (array) } (object) required |
| post_users_export_segment | Use this endpoint to export all the users within a segment. | Content-Type (string) Authorization (string) data: { . segment_id (string) . callback_endpoint (string) . fields_to_export (array) . output_format (string) } (object) required |
| post_users_export_global_control_group | Use this endpoint to export all users within a Global Control Group. | Content-Type (string) Authorization (string) data: { . callback_endpoint (string) . fields_to_export (array) . output_format (string) } (object) required |
| post_messages_live_activity_update | Use this endpoint to update and end Live Activities displayed by your iOS app. This endpoint requires additional setup. | Content-Type (string) Authorization (string) data: { . app_id (string) . activity_id (string) . content_state (object) . end_activity (boolean) . dismissal_date (string) . stale_date (string) . notification (object) } (object) required |
| get_messages_scheduled_broadcasts | Use this endpoint to return a JSON list of information about scheduled campaigns and entry Canvases between now and a designated end_time specified in the request. | Authorization (string) end_time (string) |
| post_messages_schedule_delete | Use this endpoint to cancel a message that you previously scheduled before it has been sent. | Content-Type (string) Authorization (string) data: { . schedule_id (string) } (object) required |
| post_canvas_trigger_schedule_delete | Use this endpoint to cancel a Canvas message that you previously scheduled via API-triggered before it has been sent. | Content-Type (string) Authorization (string) data: { . canvas_id (string) . schedule_id (string) } (object) required |
| post_campaigns_trigger_schedule_delete | The delete schedule endpoint allows you to cancel a message that you previously scheduled API-triggered Canvases before it has been sent. | Content-Type (string) Authorization (string) data: { . campaign_id (string) . schedule_id (string) } (object) required |
| post_messages_schedule_create | Use this endpoint to schedule a campaign, Canvas, or other message to be sent at a designated time and provides you with an identifier to reference that message for updates. | data: { . broadcast (boolean) . external_user_ids (array) . user_aliases (object) . segment_id (string) . audience (object) . campaign_id (string) . send_id (string) . override_messaging_limits (boolean) . recipient_subscription_state (string) . schedule (object) . messages (object) } (object) required |
| post_campaigns_trigger_schedule_create | Use this endpoint to send dashboard created campaign messages via API-triggered delivery, allowing you to decide what action should trigger the message to be sent. | Content-Type (string) Authorization (string) data: { . campaign_id (string) . send_id (string) . recipients (array) . audience (object) . broadcast (boolean) . trigger_properties (object) . schedule (object) } (object) required |
| post_canvas_trigger_schedule_create | Use this endpoint to schedule Canvas messages via API-triggered delivery, allowing you to decide what action should trigger the message to be sent. | Content-Type (string) Authorization (string) data: { . canvas_id (string) . recipients (array) . audience (object) . broadcast (boolean) . canvas_entry_properties (object) . schedule (object) } (object) required |
| post_messages_schedule_update | Use this endpoint to update scheduled messages. | Content-Type (string) Authorization (string) data: { . schedule_id (string) . schedule (object) . messages (object) } (object) required |
| post_campaigns_trigger_schedule_update | Use this endpoint to update scheduled API-triggered campaigns created in the dashboard, allowing you to decide what action should trigger the message to be sent. | Content-Type (string) Authorization (string) data: { . campaign_id (string) . schedule_id (string) . schedule (object) } (object) required |
| post_canvas_trigger_schedule_update | Use this endpoint to update scheduled API-triggered Canvases that were created in the dashboard. | Content-Type (string) Authorization (string) data: { . canvas_id (string) . schedule_id (string) . schedule (object) } (object) required |
| post_sends_id_create | Use this endpoint to create send IDs that can be used to send messages and track message performance programatically, without campaign creation for each send. | Content-Type (string) Authorization (string) data: { . campaign_id (string) . send_id (string) } (object) required |
| post_messages_send | Use this endpoint to send immediate messages to designated users via the Braze API. | Content-Type (string) Authorization (string) data: { . broadcast (string) . external_user_ids (array) . user_aliases (object) . segment_id (string) . audience (object) . campaign_id (string) . send_id (string) . override_frequency_capping (string) . recipient_subscription_state (string) . messages (object) } (object) required |
| post_transactional_v1_campaigns_by_campaign_id_send | Use this endpoint to send immediate, one-off transactional messages to a designated user. | campaign_id (string) Content-Type (string) Authorization (string) data: { . external_send_id (string) . trigger_properties (object) . recipient (array) } (object) required |
| post_campaigns_trigger_send | Use this endpoint to send immediate, ad-hoc messages to designated users via API-triggered delivery. | Content-Type (string) Authorization (string) data: { . campaign_id (string) . send_id (string) . trigger_properties (object) . broadcast (boolean) . audience (object) . recipients (array) } (object) required |
| post_canvas_trigger_send | Use this endpoint to send Canvas messages via API-triggered delivery. | Content-Type (string) Authorization (string) data: { . canvas_id (string) . canvas_entry_properties (object) . broadcast (boolean) . audience (object) . recipients (array) } (object) required |
| get_preference_center_v1_by_preference_center_external_id_url_by_user_id | Use this endpoint to generate a URL for a preference center. | PreferenceCenterExternalID (string) UserID (string) Authorization (string) preference_center_api_id (string) external_id (string) |
| get_preference_center_v1_list | Use this endpoint to list your available preference centers. | Authorization (string) |
| get_preference_center_v1_by_preference_center_external_id | Use this endpoint to view the details for your preference centers, including when it was created and updated. | PreferenceCenterExternalID (string) Authorization (string) |
| put_preference_center_v1_by_preference_center_external_id | Use this endpoint to update a preference center. | PreferenceCenterExternalID (string) Content-Type (string) Authorization (string) data: { . name (string) . preference_center_title (string) . preference_center_page_html (string) . confirmation_page_html (string) . options (object) } (object) required |
| post_preference_center_v1 | Use this endpoint to create a preference center to allow users to manage their notification preferences for your email campaigns. | Content-Type (string) Authorization (string) data: { . name (string) . preference_center_title (string) . preference_center_page_html (string) . confirmation_page_html (string) . state (string) . options (object) } (object) required |
| delete_scim_v2_users_by_id | Use this endpoint to permanently delete an existing dashboard user by specifying the resource id returned by the SCIM and lt;code and gt;POST and lt;/code and gt; method. | id (string) Content-Type (string) X-Request-Origin (string) Authorization (string) |
| get_scim_v2_users_by_id | Use this endpoint to look up an existing dashboard user account by specifying the resource id returned by the SCIM and lt;code and gt;POST and lt;/code and gt; method. | id (string) Content-Type (string) X-Request-Origin (string) Authorization (string) |
| put_scim_v2_users_by_id | Use this endpoint to update an existing dashboard user account by specifying the resource id returned by the SCIM and lt;code and gt;POST and lt;/code and gt; method. | id (string) Content-Type (string) X-Request-Origin (string) Authorization (string) data: { . schemas (array) . name (object) . department (string) . permissions (object) } (object) required |
| get_scim_v2_users | Use this endpoint to look up an existing dashboard user account by specifying their email in the filter query parameter. | Content-Type (string) X-Request-Origin (string) Authorization (string) filter (string) |
| post_scim_v2_users | Use this endpoint to create a new dashboard user account by specifying email, given and family names, permissions for setting permissions at the company, app group, and team level. | Content-Type (string) X-Request-Origin (string) Authorization (string) data: { . schemas (array) . userName (string) . name (object) . department (string) . permissions (object) } (object) required |
| get_sms_invalid_phone_numbers | Use this endpoint to pull a list of phone numbers that have been deemed “invalid” within a certain time frame. | Authorization (string) start_date (string) end_date (string) limit (integer) offset (integer) phone_numbers (integer) reason (string) |
| post_sms_invalid_phone_numbers_remove | Use this endpoint to remove “invalid” phone numbers from Braze’s invalid list. | Authorization (string) Content-Type (string) data: { . phone_numbers (array) } (object) required |
| get_subscription_status_get | Use this endpoint to get the subscription state of a user in a subscription group. | Authorization (string) subscription_group_id (string) external_id (string) email (string) phone (string) |
| get_subscription_user_status | Use this endpoint to list and get the subscription groups of a certain user. | Authorization (string) external_id (string) email (string) limit (integer) offset (integer) phone (string) |
| post_subscription_status_set | Use this endpoint to batch update the subscription state of up to 50 users on the Braze dashboard. | Content-Type (string) Authorization (string) data: { . subscription_group_id (string) . subscription_state (string) . external_id (array) . email (array) } (object) required |
| post_v2_subscription_status_set | Use this endpoint to batch update the subscription state of up to 50 users on the Braze dashboard. | Content-Type (string) Authorization (string) data: { . subscription_groups (array) } (object) required |
| get_content_blocks_list | Use this endpoint to list your existing Content Blocks information. | Authorization (string) modified_after (string) modified_before (string) limit (integer) offset (integer) |
| get_content_blocks_info | Use this endpoint to call information for your existing Content Blocks. | Authorization (string) content_block_id (string) include_inclusion_data (boolean) |
| post_content_blocks_create | Use this endpoint to create a Content Block. | Content-Type (string) Authorization (string) data: { . name (string) . description (string) . content (string) . state (string) . tags (array) } (object) required |
| post_content_blocks_update | Use this endpoint to update a Content Block. | Content-Type (string) Authorization (string) data: { . content_block_id (string) . name (string) . description (string) . content (string) . state (string) . tags (array) } (object) required |
| get_templates_email_list | Use this endpoint to get a list of available templates in your Braze account. | Authorization (string) modified_after (string) modified_before (string) limit (integer) offset (integer) |
| get_templates_email_info | Use this endpoint to get information on your email templates. | Authorization (string) email_template_id (string) |
| post_templates_email_create | Use this endpoint to create email templates on the Braze dashboard. | Content-Type (string) Authorization (string) template_name (string) subject (string) body (string) plaintext_body (string) preheader (string) tags (string) should_inline_css (boolean) data: { . template_name (string) . subject (string) . body (string) . plaintext_body (string) . preheader (string) . tags (array) . should_inline_css (boolean) } (object) required |
| post_templates_email_update | Use this endpoint to update email templates on the Braze dashboard. | Content-Type (string) Authorization (string) email_template_id (string) template_name (string) subject (string) body (string) plaintext_body (string) preheader (string) tags (string) should_inline_css (boolean) data: { . email_template_id (string) . template_name (string) . subject (string) . body (string) . plaintext_body (string) . preheader (string) . tags (array) . should_inline_css (boolean) } (object) required |
| post_users_external_ids_rename | Use this endpoint to rename your users’ external IDs. | Content-Type (string) Authorization (string) data: { . external_id_renames (array) } (object) required |
| post_users_external_ids_remove | Use this endpoint to remove your users' old deprecated external IDs. | Content-Type (string) Authorization (string) data: { . external_ids (array) } (object) required |
| post_users_alias_new | Use this endpoint to add new user aliases for existing identified users, or to create new unidentified users. | Content-Type (string) Authorization (string) data: { . user_aliases (array) } (object) required |
| post_users_alias_update | Use this endpoint to update existing user aliases. | Content-Type (string) Authorization (string) data: { . alias_updates (array) } (object) required |
| post_users_identify | Use this endpoint to identify an unidentified alias-only or email-only user using the provided external ID. | Content-Type (string) Authorization (string) data: { . aliases_to_identify (array) . emails_to_identify (array) . phone_numbers_to_identify (array) . merge_behavior (string) } (object) required |
| post_users_track | Use this endpoint to record custom events, purchases, and update user profile attributes. | Content-Type (string) Authorization (string) data: { . attributes (array) . events (array) . purchases (array) } (object) required |
| post_users_delete | Use this endpoint to delete any user profile by specifying a known user identifier. | Content-Type (string) Authorization (string) data: { . external_ids (array) . braze_ids (array) . user_aliases (array) } (object) required |
| post_users_merge | Use this endpoint to merge one user into another user. | Content-Type (string) Authorization (string) data: { . merge_updates (array) } (object) required |