Sending Messages Immediately via API Only
POST https://{{instance_url}}/messages/send
This endpoint allows you send your messages using our API. Be sure to include Messaging Objects in your body to complete your requests.
The send endpoint allows you to send immediate, ad-hoc messages to designated users. If you are targeting a segment, a record of your request will be stored in the Developer Console .
Request Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
broadcast | Optional | Boolean | See broadcast -- defaults to false on 8/31/17, must be set to true if recipientsis omitted |
external_user_ids | Optional | Array of strings | See external identifier |
user_aliases | Optional | Array of user alias objects | See user alias object |
segment_id | Optional | String | See segment identifier |
audience | Optional | Connected audience object | See connected audience |
campaign_id | Optional* | String | *Required if you wish to track campaign stats (e.g. sends, clicks, bounces, etc) on the Braze dashboard. See campaign identifier for more information |
send_id | Optional | String | See send identifier |
override_frequency_capping | Optional | Boolean | Ignore frequency_capping for campaigns, defaults to false |
recipient_subscription_state | Optional | String | Use this to send messages to only users who have opted in ('opted_in'), only users who have subscribed or are opted in ('subscribed') or to all users, including unsubscribed users ('all'), the latter being useful for transactional email messaging. Defaults to 'subscribed' |
messages | Optional | Messaging objects | See available messaging objects |
Request Components
- Broadcast
- User Alias Object
- Segment Identifier
- Connected Audience
- Campaign Identifier
- Recipients
- API Parameters
Available Messaging Objects
- Android Objects
- Apple Objects
- Content Cards Object
- Email Object
- Kindle or FireOS Object
- SMS Object
- Web Objects
- Webhook Object
- Windows Objects
Response Details
Message sending endpoint responses will include the message’s dispatch_id for reference back to the dispatch of the message. The dispatch_id is the id of the message dispatch (unique id for each ‘transmission’ sent from the Braze platform). For more information on dispatch_id checkout out our documentation.