Braze Endpoints

Braze Endpoints

Auth

ApiKey Authorization in header

Base URL

https://{{instance_url}}

Setup

1. Set your API key in the appropriate header
2. GET /email/hard_bounces -- verify access
3. POST /email/status -- create first status

Endpoints

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

email

campaigns

sends

canvas

events

kpi

feed

purchases

segments

sessions

users

messages

transactional

sms

subscription

content_blocks

templates

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 remove?" -> POST /email/spam/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_series?" -> GET /sends/data_series
• "List all data_series?" -> GET /canvas/data_series
• "List all data_summary?" -> GET /canvas/data_summary
• "List all details?" -> GET /canvas/details
• "List all list?" -> GET /canvas/list
• "List all list?" -> GET /events/list
• "List all data_series?" -> GET /events/data_series
• "List all data_series?" -> GET /kpi/new_users/data_series
• "List all data_series?" -> GET /kpi/dau/data_series
• "List all data_series?" -> GET /kpi/mau/data_series
• "List all data_series?" -> GET /kpi/uninstalls/data_series
• "List all data_series?" -> GET /feed/data_series
• "List all details?" -> GET /feed/details
• "List all list?" -> GET /feed/list
• "List all product_list?" -> GET /purchases/product_list
• "List all list?" -> GET /segments/list
• "List all data_series?" -> GET /segments/data_series
• "List all details?" -> GET /segments/details
• "List all data_series?" -> GET /sessions/data_series
• "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 delete?" -> POST /campaigns/trigger/schedule/delete
• "Create a delete?" -> POST /canvas/trigger/schedule/delete
• "Create a create?" -> POST /messages/schedule/create
• "Create a create?" -> POST /campaigns/trigger/schedule/create
• "Create a create?" -> POST /canvas/trigger/schedule/create
• "Create a update?" -> POST /messages/schedule/update
• "Create a update?" -> POST /campaigns/trigger/schedule/update
• "Create a update?" -> POST /canvas/trigger/schedule/update
• "Create a create?" -> POST /sends/id/create
• "Create a send?" -> POST /messages/send
• "Create a send?" -> POST /campaigns/trigger/send
• "Create a send?" -> POST /canvas/trigger/send
• "Create a send?" -> POST /transactional/v1/campaigns/YOUR_CAMPAIGN_ID_HERE/send
• "List all invalid_phone_numbers?" -> GET /sms/invalid_phone_numbers
• "Create a remove?" -> POST /sms/invalid_phone_numbers/remove
• "List all get?" -> GET /subscription/status/get
• "List all status?" -> GET /subscription/user/status
• "Create a set?" -> POST /subscription/status/set
• "List all list?" -> GET /content_blocks/list
• "List all info?" -> GET /content_blocks/info
• "Create a create?" -> POST /content_blocks/create
• "Create a update?" -> POST /content_blocks/update
• "List all list?" -> GET /templates/email/list
• "List all info?" -> GET /templates/email/info
• "Create a create?" -> POST /templates/email/create
• "Create a update?" -> POST /templates/email/update
• "Create a remove?" -> POST /users/external_ids/remove
• "Create a rename?" -> POST /users/external_ids/rename
• "Create a new?" -> POST /users/alias/new
• "Create a delete?" -> POST /users/delete
• "Create a identify?" -> POST /users/identify
• "Create a track?" -> POST /users/track
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

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