Braze
App · 20 actions
Connect Braze to automate customer profiles and messaging.
Actions
| Action | What it does |
|---|---|
| Create user aliases | Add new user aliases, each a name and label, to existing users or as new alias-only users. |
| Delete users | Permanently delete users by external ID or Braze ID, with their profile data. |
| Export users by identifier | Get the full profiles of users by external ID or Braze ID, including their attributes, events, purchases and devices. |
| Get campaign details | Get one campaign by its ID, with its name, channels, schedule, messages and whether it is enabled or archived. |
| Get Canvas details | Get one Canvas by its ID, with its name, steps, variants, schedule and whether it is enabled or archived. |
| Get email template | Get one email template by its ID, with its name, subject, body and tags. |
| Get segment details | Get one segment by its ID, with its name, description, filter text and tags. |
| Get subscription group status | Get whether a user, identified by external ID, email or phone number, is subscribed to a subscription group. |
| Identify users | Merge alias-only users into users with an external ID, so their history moves to the identified profile. |
| List campaigns | List your Braze campaigns, a page at a time, optionally including archived ones. |
| List Canvases | List your Braze Canvases, a page at a time, optionally including archived ones. |
| List email templates | List your email templates, optionally limited to those modified in a date range, with each template's ID, name and last update. |
| List segments | List your Braze segments, a page at a time, with each segment's ID, name, analytics tracking setting and tags. |
| List user subscription groups | Get the subscription groups of a user identified by external ID, email or phone. |
| Send API triggered campaign | Send an API-triggered campaign by its ID to the recipients you list or to its whole segment, optionally with properties used in the message. |
| Send Canvas | Send an API-triggered Canvas by its ID to the recipients you list or to its whole audience, optionally with entry properties. |
| Send messages | Send messages right away, such as an email or push, to the users you list by external ID or to everyone. |
| Set email subscription | Set the email subscription state of an email address to opted in, subscribed or unsubscribed. |
| Set subscription group status | Subscribe or unsubscribe a user from a subscription group, identified by external ID, email or phone number. |
| Update users and track events | Record custom attributes, custom events and purchases for users, creating users that do not exist yet. |
Create user aliases
Add new user aliases, each a name and label, to existing users or as new alias-only users.
Inputs
- User aliases
user_aliaseslistRequired - User aliases for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Delete users
Permanently delete users by external ID or Braze ID, with their profile data. Deleted users cannot be restored.
Inputs
- External ids
external_idslist - External ids for this request.
- Braze ids
braze_idslist - Braze ids for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Export users by identifier
Get the full profiles of users by external ID or Braze ID, including their attributes, events, purchases and devices.
Inputs
- External ids
external_idslist - External ids for this request.
- Braze ids
braze_idslist - Braze ids for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get campaign details
Get one campaign by its ID, with its name, channels, schedule, messages and whether it is enabled or archived.
Inputs
- Campaign
campaign_idtextRequired - Campaign id for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get Canvas details
Get one Canvas by its ID, with its name, steps, variants, schedule and whether it is enabled or archived.
Inputs
- Canvas
canvas_idtextRequired - Canvas id for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get email template
Get one email template by its ID, with its name, subject, body and tags.
Inputs
- Email template id
email_template_idtextRequired - Email template id for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get segment details
Get one segment by its ID, with its name, description, filter text and tags.
Inputs
- Segment
segment_idtextRequired - Segment id for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get subscription group status
Get whether a user, identified by external ID, email or phone number, is subscribed to a subscription group.
Inputs
- Subscription group id
subscription_group_idtextRequired - Subscription group id for this request.
- External id
external_idtext - External id for this request.
- Email
emailtext - Email for this request.
- Phone
phonetext - Phone for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Identify users
Merge alias-only users into users with an external ID, so their history moves to the identified profile.
Inputs
- Aliases to identify
aliases_to_identifylistRequired - Aliases to identify for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List campaigns
List your Braze campaigns, a page at a time, optionally including archived ones. Returns each campaign's ID, name, tags and last edited time.
Inputs
- Page
pagenumber - Page for this request.At least 0.
- Include archived
include_archivedtrue/false - Include archived for this request.
- Sort direction
sort_directiontext - Sort direction for this request.One of:
asc,desc.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List Canvases
List your Braze Canvases, a page at a time, optionally including archived ones. Returns each Canvas's ID, name, tags and last edited time.
Inputs
- Page
pagenumber - Page for this request.At least 0.
- Include archived
include_archivedtrue/false - Include archived for this request.
- Sort direction
sort_directiontext - Sort direction for this request.One of:
asc,desc.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List email templates
List your email templates, optionally limited to those modified in a date range, with each template's ID, name and last update.
Inputs
- Limit
limitnumber - Limit for this request.From 1 to 1000.
- Offset
offsetnumber - Offset for this request.At least 0.
- Modified after
modified_afterdate and time - Only templates modified modified after.
- Modified before
modified_beforedate and time - Only templates modified modified before.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List segments
List your Braze segments, a page at a time, with each segment's ID, name, analytics tracking setting and tags.
Inputs
- Page
pagenumber - Page for this request.At least 0.
- Sort direction
sort_directiontext - Sort direction for this request.One of:
asc,desc.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List user subscription groups
Get the subscription groups of a user identified by external ID, email or phone.
Inputs
- External id
external_idtext - External id for this request.
- Email
emailtext - Email for this request.
- Phone
phonetext - Phone for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Send API triggered campaign
Send an API-triggered campaign by its ID to the recipients you list or to its whole segment, optionally with properties used in the message. Returns a dispatch ID.
Inputs
- Campaign
campaign_idtextRequired - Campaign id for this request.
- Recipients
recipientslist - Recipients for this request.
- Broadcast
broadcasttrue/false - Broadcast for this request.
- Trigger properties
trigger_propertiesobject - Trigger properties for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Send Canvas
Send an API-triggered Canvas by its ID to the recipients you list or to its whole audience, optionally with entry properties. Returns a dispatch ID.
Inputs
- Canvas
canvas_idtextRequired - Canvas id for this request.
- Recipients
recipientslist - Recipients for this request.
- Broadcast
broadcasttrue/false - Broadcast for this request.
- Canvas entry properties
canvas_entry_propertiesobject - Canvas entry properties for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Send messages
Send messages right away, such as an email or push, to the users you list by external ID or to everyone. Returns a dispatch ID.
Inputs
- External user ids
external_user_idslist - External user ids for this request.
- Messages
messagesobjectRequired - Messages for this request.
- Broadcast
broadcasttrue/false - Broadcast for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Set email subscription
Set the email subscription state of an email address to opted in, subscribed or unsubscribed.
Inputs
- Email
emailtextRequired - Email for this request.
- Subscription state
subscription_statetextRequired - Subscription state for this request.One of:
opted_in,subscribed,unsubscribed.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Set subscription group status
Subscribe or unsubscribe a user from a subscription group, identified by external ID, email or phone number.
Inputs
- Subscription group id
subscription_group_idtextRequired - Subscription group id for this request.
- Subscription state
subscription_statetextRequired - Subscription state for this request.One of:
subscribed,unsubscribed. - External id
external_idlist - External id for this request.
- Email
emaillist - Email for this request.
- Phone
phonelist - Phone for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Update users and track events
Record custom attributes, custom events and purchases for users, creating users that do not exist yet. Returns how many of each were processed.
Inputs
- Attributes
attributeslist - Attributes for this request.
- Events
eventslist - Events for this request.
- Purchases
purchaseslist - Purchases for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}