Braze

App · 20 actions

Connect Braze to automate customer profiles and messaging.

Actions

ActionWhat it does
Create user aliasesAdd new user aliases, each a name and label, to existing users or as new alias-only users.
Delete usersPermanently delete users by external ID or Braze ID, with their profile data.
Export users by identifierGet the full profiles of users by external ID or Braze ID, including their attributes, events, purchases and devices.
Get campaign detailsGet one campaign by its ID, with its name, channels, schedule, messages and whether it is enabled or archived.
Get Canvas detailsGet one Canvas by its ID, with its name, steps, variants, schedule and whether it is enabled or archived.
Get email templateGet one email template by its ID, with its name, subject, body and tags.
Get segment detailsGet one segment by its ID, with its name, description, filter text and tags.
Get subscription group statusGet whether a user, identified by external ID, email or phone number, is subscribed to a subscription group.
Identify usersMerge alias-only users into users with an external ID, so their history moves to the identified profile.
List campaignsList your Braze campaigns, a page at a time, optionally including archived ones.
List CanvasesList your Braze Canvases, a page at a time, optionally including archived ones.
List email templatesList your email templates, optionally limited to those modified in a date range, with each template's ID, name and last update.
List segmentsList your Braze segments, a page at a time, with each segment's ID, name, analytics tracking setting and tags.
List user subscription groupsGet the subscription groups of a user identified by external ID, email or phone.
Send API triggered campaignSend 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 CanvasSend an API-triggered Canvas by its ID to the recipients you list or to its whole audience, optionally with entry properties.
Send messagesSend messages right away, such as an email or push, to the users you list by external ID or to everyone.
Set email subscriptionSet the email subscription state of an email address to opted in, subscribed or unsubscribed.
Set subscription group statusSubscribe or unsubscribe a user from a subscription group, identified by external ID, email or phone number.
Update users and track eventsRecord 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 aliasesuser_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 idsexternal_idslist
External ids for this request.
Braze idsbraze_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 idsexternal_idslist
External ids for this request.
Braze idsbraze_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

Campaigncampaign_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

Canvascanvas_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 idemail_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

Segmentsegment_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 idsubscription_group_idtextRequired
Subscription group id for this request.
External idexternal_idtext
External id for this request.
Emailemailtext
Email for this request.
Phonephonetext
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 identifyaliases_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

Pagepagenumber
Page for this request.At least 0.
Include archivedinclude_archivedtrue/false
Include archived for this request.
Sort directionsort_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

Pagepagenumber
Page for this request.At least 0.
Include archivedinclude_archivedtrue/false
Include archived for this request.
Sort directionsort_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

Limitlimitnumber
Limit for this request.From 1 to 1000.
Offsetoffsetnumber
Offset for this request.At least 0.
Modified aftermodified_afterdate and time
Only templates modified modified after.
Modified beforemodified_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

Pagepagenumber
Page for this request.At least 0.
Sort directionsort_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 idexternal_idtext
External id for this request.
Emailemailtext
Email for this request.
Phonephonetext
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

Campaigncampaign_idtextRequired
Campaign id for this request.
Recipientsrecipientslist
Recipients for this request.
Broadcastbroadcasttrue/false
Broadcast for this request.
Trigger propertiestrigger_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

Canvascanvas_idtextRequired
Canvas id for this request.
Recipientsrecipientslist
Recipients for this request.
Broadcastbroadcasttrue/false
Broadcast for this request.
Canvas entry propertiescanvas_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 idsexternal_user_idslist
External user ids for this request.
MessagesmessagesobjectRequired
Messages for this request.
Broadcastbroadcasttrue/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

EmailemailtextRequired
Email for this request.
Subscription statesubscription_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 idsubscription_group_idtextRequired
Subscription group id for this request.
Subscription statesubscription_statetextRequired
Subscription state for this request.One of: subscribed, unsubscribed.
External idexternal_idlist
External id for this request.
Emailemaillist
Email for this request.
Phonephonelist
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

Attributesattributeslist
Attributes for this request.
Eventseventslist
Events for this request.
Purchasespurchaseslist
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
}

On this page