---
name: braze-endpoints
description: "Braze Endpoints API skill. Use when working with Braze Endpoints for email, campaigns, sends. Covers 68 endpoints."
version: 1.0.0
generator: lapsh
---

# Braze Endpoints

## Auth
ApiKey Authorization in header

## Base URL
Not specified.

## Setup
1. Set your API key in the appropriate header
2. GET /email/hard_bounces -- this endpoint allows you to pull a list of email addresses that have “hard bounced” your email messages within a certain time frame
3. POST /email/status -- create first status

## Endpoints
68 endpoints across 17 groups. See references/api-spec.lap for full details.

### Email
| Method | Path | Description |
|--------|------|-------------|
| GET | /email/hard_bounces | This endpoint allows you to pull a list of email addresses that have “hard bounced” your email messages within a certain time frame |
| GET | /email/unsubscribes | Use this endpoint to return emails that have unsubscribed during the time period from `start_date` to `end_date` |
| POST | /email/status | This endpoint allows you to set the email subscription state for your users |
| POST | /email/bounce/remove | This endpoint allows you to remove email addresses from your Braze bounce list |
| POST | /email/spam/remove | This endpoint allows you to remove email addresses from your Braze spam list |
| POST | /email/blacklist | Blacklisting an email address will unsubscribe the user from email and mark them as hard bounced |

### Campaigns
| Method | Path | Description |
|--------|------|-------------|
| GET | /campaigns/data_series | This endpoint allows you to retrieve a daily series of various stats for a campaign over time |
| GET | /campaigns/details | This endpoint allows you to retrieve relevant information on a specified campaign, which can be identified by the `campaign_id` |
| GET | /campaigns/list | This endpoint allows you 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 |
| POST | /campaigns/trigger/schedule/delete | The delete schedule endpoint allows you to cancel a message that you previously scheduled API Triggered Campaigns before it has been sent |
| POST | /campaigns/trigger/schedule/create | Use this endpoint to trigger API-triggered campaigns, which are created on the dashboard and initiated via the API |
| POST | /campaigns/trigger/schedule/update | Use this endpoint to update scheduled API Triggered Campaigns, which are created on the Dashboard and initiated via the API |
| POST | /campaigns/trigger/send | API-triggered delivery allows you to house message content inside of the Braze dashboard while dictating when a message is sent, and to whom via your API |

### Sends
| Method | Path | Description |
|--------|------|-------------|
| GET | /sends/data_series | This endpoint allows you to retrieve a daily series of various stats for a tracked `send_id` |
| POST | /sends/id/create | Braze’s Send Identifier adds the ability to send messages and track message performance entirely programmatically, without campaign creation for each send |

### Canvas
| Method | Path | Description |
|--------|------|-------------|
| GET | /canvas/data_series | This endpoint allows you to export time series data for a Canvas |
| GET | /canvas/data_summary | This endpoint allows you to export rollups of time series data for a Canvas, providing a concise summary of a Canvas' results |
| GET | /canvas/details | This endpoint allows you to export metadata about a Canvas, such as the name, time created, current status, and more |
| GET | /canvas/list | This endpoint allows you to export a list of Canvases, including the name, Canvas API identifier and associated tags |
| POST | /canvas/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 |
| POST | /canvas/trigger/schedule/create | Use this endpoint to trigger API Triggered Canvases, which are created on the Dashboard and initiated via the API |
| POST | /canvas/trigger/schedule/update | Use this endpoint to update scheduled API-Triggered Canvases, which are created on the dashboard and initiated via the API |
| POST | /canvas/trigger/send | API-Triggered Delivery allows you to house message content inside of the Braze dashboard while dictating when a message is sent, and to whom via your API |

### Events
| Method | Path | Description |
|--------|------|-------------|
| GET | /events/list | This endpoint allows you to export a list of custom events that have been recorded for your app |
| GET | /events/data_series | This endpoint allows you to retrieve a series of the number of occurrences of a custom event in your app over a designated time period |

### Kpi
| Method | Path | Description |
|--------|------|-------------|
| GET | /kpi/new_users/data_series | This endpoint allows you to retrieve a daily series of the total number of new users on each date |
| GET | /kpi/dau/data_series | This endpoint allows you to retrieve a daily series of the total number of unique active users on each date |
| GET | /kpi/mau/data_series | This endpoint allows you to retrieve a daily series of the total number of unique active users over a 30-day rolling window |
| GET | /kpi/uninstalls/data_series | This endpoint allows you to retrieve a daily series of the total number of uninstalls on each date |

### Feed
| Method | Path | Description |
|--------|------|-------------|
| GET | /feed/data_series | This endpoint allows you to retrieve a daily series of engagement stats for a card over time |
| GET | /feed/details | This endpoint allows you to retrieve relevant information on the card, which can be identified by the `card_id` |
| GET | /feed/list | This endpoint allows you to export a list of News Feed cards, each of which will include its name and Card API Identifier |

### Purchases
| Method | Path | Description |
|--------|------|-------------|
| GET | /purchases/product_list | This endpoint returns paginated lists of product IDs |

### Segments
| Method | Path | Description |
|--------|------|-------------|
| GET | /segments/list | This endpoint allows you to export a list of segments, each of which will include its name, Segment API Identifier, and whether it has analytics tracking enabled |
| GET | /segments/data_series | This endpoint allows you to retrieve a daily series of the size of a segment over time for a segment |
| GET | /segments/details | This endpoint allows you to retrieve relevant information on the segment, which can be identified by the `segment_id` |

### Sessions
| Method | Path | Description |
|--------|------|-------------|
| GET | /sessions/data_series | This endpoint allows you to retrieve a series of the number of sessions for your app over a designated time period |

### Users
| Method | Path | Description |
|--------|------|-------------|
| POST | /users/export/ids | This endpoint allows you to export data from any user profile by specifying a form of user identifier |
| POST | /users/export/segment | This endpoint allows you to export all the users within a segment |
| POST | /users/export/global_control_group | This endpoint allows you to export all the users within the Global Control Group |
| POST | /users/external_ids/remove | > **Note:** For security purposes, this feature is disabled by default |
| POST | /users/external_ids/rename | > **Note:** For security purposes, this feature is disabled by default |
| POST | /users/alias/new | Use this endpoint to add new user aliases for existing identified users, or to create new unidentified users |
| POST | /users/delete | This endpoint allows you to delete any user profile by specifying a known user identifier |
| POST | /users/identify | Use this endpoint to identify an unidentified (alias-only) user |
| POST | /users/track | Use this endpoint to record custom events, purchases, and update user profile attributes |

### Messages
| Method | Path | Description |
|--------|------|-------------|
| GET | /messages/scheduled_broadcasts | You can view a JSON list of upcoming and scheduled Campaigns and Canvases using the following information and parameters |
| POST | /messages/schedule/delete | The delete scheduled messages endpoint allows you to cancel a message that you previously scheduled _before_ it has been sent |
| POST | /messages/schedule/create | Use this endpoint to send messages directly from the API |
| POST | /messages/schedule/update | The messages update schedule endpoint accepts updates to either the `schedule` or `messages` parameter or both |
| POST | /messages/send | This endpoint allows you send your messages using our API |

### Transactional
| Method | Path | Description |
|--------|------|-------------|
| POST | /transactional/v1/campaigns/YOUR_CAMPAIGN_ID_HERE/send | The Send Transactional Email endpoint allows you to send immediate, ad-hoc messages to a designated user |

### Sms
| Method | Path | Description |
|--------|------|-------------|
| GET | /sms/invalid_phone_numbers | This endpoint allows you to pull a list of phone numbers that have been deemed “invalid” within a certain time frame |
| POST | /sms/invalid_phone_numbers/remove | This endpoint allows you to remove “invalid” phone numbers from Braze’s invalid list |

### Subscription
| Method | Path | Description |
|--------|------|-------------|
| GET | /subscription/status/get | Use the following endpoint to get the subscription state of a user in a subscription group |
| GET | /subscription/user/status | Use this endpoint to list and get the subscription groups of a certain user |
| POST | /subscription/status/set | Use the endpoint below to update the subscription state of a user on the Braze dashboard |
| GET | /subscription/status/get | Use this endpoint to get the subscription state of a user in a subscription group |
| GET | /subscription/user/status | Use this endpoint to list and get the subscription groups of a certain user |
| POST | /subscription/status/set | Use this endpoint to update the subscription state of a user on the Braze dashboard |

### Content_blocks
| Method | Path | Description |
|--------|------|-------------|
| GET | /content_blocks/list | This endpoint will list your existing [Content Blocks](https://www |
| GET | /content_blocks/info | This endpoint will call information for an existing [Content Block](https://www |
| POST | /content_blocks/create | This endpoint will create a [Content Block](https://www |
| POST | /content_blocks/update | This endpoint will update a [Content Block](https://www |

### Templates
| Method | Path | Description |
|--------|------|-------------|
| GET | /templates/email/list | Use this endpoint to get a list of available templates in your Braze account |
| GET | /templates/email/info | Use to get information on your email templates |
| POST | /templates/email/create | Use the Template REST APIs to programmatically manage the email templates that you have stored on the Braze dashboard, on the Templates & Media page |
| POST | /templates/email/update | Use the Template REST APIs to programmatically manage the email templates that you have stored on the Braze dashboard, on the Templates & Media page |

## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all hard_bounces?" -> GET /email/hard_bounces
- "List all unsubscribes?" -> GET /email/unsubscribes
- "Create a status?" -> POST /email/status
- "Create a remove?" -> POST /email/bounce/remove
- "Create a blacklist?" -> POST /email/blacklist
- "List all data_series?" -> GET /campaigns/data_series
- "List all details?" -> GET /campaigns/details
- "List all list?" -> GET /campaigns/list
- "List all data_summary?" -> GET /canvas/data_summary
- "List all product_list?" -> GET /purchases/product_list
- "Create a id?" -> POST /users/export/ids
- "Create a segment?" -> POST /users/export/segment
- "Create a global_control_group?" -> POST /users/export/global_control_group
- "List all scheduled_broadcasts?" -> GET /messages/scheduled_broadcasts
- "Create a delete?" -> POST /messages/schedule/delete
- "Create a create?" -> POST /messages/schedule/create
- "Create a update?" -> POST /messages/schedule/update
- "Create a send?" -> POST /messages/send
- "List all invalid_phone_numbers?" -> GET /sms/invalid_phone_numbers
- "List all get?" -> GET /subscription/status/get
- "List all status?" -> GET /subscription/user/status
- "Create a set?" -> POST /subscription/status/set
- "List all info?" -> GET /content_blocks/info
- "Create a rename?" -> POST /users/external_ids/rename
- "Create a new?" -> POST /users/alias/new
- "Create a identify?" -> POST /users/identify
- "Create a track?" -> POST /users/track
- "How to authenticate?" -> See Auth section above

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Paginated endpoints accept limit/offset or cursor parameters
- Create/update endpoints return the modified resource on success

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)