{ "opencollection": "1.0.0", "info": { "name": "Braze Messaging > Send Messages API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Messaging > Send Messages", "type": "folder" }, "items": [ { "info": { "name": "Create Send IDs For Message Send Tracking", "type": "http" }, "http": { "method": "POST", "url": "https://rest.iad-01.braze.com/sends/id/create", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "Bearer {{api_key}}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "> Use this endpoint to create send IDs that can be used to send messages and track message performance programatically, without campaign creation for each send. \n \n\nTo use this endpoint, youll need to generate an API key with the `sends.id.create` permission.\n\nUsing the send identifier to track and send messages is useful if you are planning to programmatically generate and send content.\n\n## Rate limit\n\nThe daily maximum number of custom send identifiers that can be created via this endpoint is" }, { "info": { "name": "Send Messages Immediately via API Only", "type": "http" }, "http": { "method": "POST", "url": "https://rest.iad-01.braze.com/messages/send", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "Bearer {{api_key}}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "> Use this endpoint to send immediate, ad-hoc messages to designated users via the Braze API. \n \n\nTo use this endpoint, youll need to generate an API key with the `messages.send` permission.\n\nBe sure to include Messaging Objects in your body to complete your requests.\n\nIf you are targeting a segment, a record of your request will be stored in the [Developer Console](https://dashboard.braze.com/app_settings/developer_console/activitylog/).\n\n## Rate limit\n\nWhen specifying a segment or Connected A" }, { "info": { "name": "Send Transactional Email via API Triggered Delivery", "type": "http" }, "http": { "method": "POST", "url": "https://rest.iad-01.braze.com/transactional/v1/campaigns/:campaign_id/send", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "Bearer {{api_key}}" } ], "params": [ { "name": "campaign_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "> Use this endpoint to send immediate, ad-hoc transactional messages to a designated user. \n \n\nTo use this endpoint, youll need to generate an API key with the `transactional.send` permission.\n\nThis endpoint is used alongside the creation of a [Transactional Email campaign](https://www.braze.com/docs/api/api_campaigns/transactional_campaigns) and corresponding campaign ID.\n\n> **Important:** Transactional Email is currently available as part of select Braze packages. Reach out to your Braze cust" }, { "info": { "name": "Send Campaign Messages via API Triggered Delivery", "type": "http" }, "http": { "method": "POST", "url": "https://rest.iad-01.braze.com/campaigns/trigger/send", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "Bearer {{api_key}}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "> Use this endpoint to send immediate, ad-hoc messages to designated users via API-triggered delivery. \n \n\nTo use this endpoint, youll need to generate an API key with the `campaigns.trigger.send` permission.\n\nAPI-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.\n\nIf you are targeting a segment, a record of your request will be stored in the [Developer Console](https://dashboard.braze.com/app_se" }, { "info": { "name": "Send Canvas Messages via API Triggered Delivery", "type": "http" }, "http": { "method": "POST", "url": "https://rest.iad-01.braze.com/canvas/trigger/send", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "Authorization", "value": "Bearer {{api_key}}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "> Use this endpoint to send Canvas messages via API-triggered delivery. \n \n\nTo use this endpoint, youll need to generate an API key with the `canvas.trigger.send` permission.\n\nAPI-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.\n\nNote that to send messages with this endpoint, you must have a [Canvas ID](https://www.braze.com/docs/api/identifier_types/#canvas-api-identifier) created when you bui" } ] } ], "bundled": true }