DataFlex / Braze Endpoints / Sending Messages Immediately via API Only
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "broadcast": "false",
// "external_user_ids": "external_user_identifiers",
// "user_aliases": {
// "alias_name": "example_name",
// "alias_label": "example_label"
// },
// "segment_id": "segment_identifier",
// "audience": {
// "AND": [
// {
// "custom_attribute": {
// "custom_attribute_name": "eye_color",
// "comparison": "equals",
// "value": "blue"
// }
// },
// {
// "custom_attribute": {
// "custom_attribute_name": "favorite_foods",
// "comparison": "includes_value",
// "value": "pizza"
// }
// },
// {
// "OR": [
// {
// "custom_attribute": {
// "custom_attribute_name": "last_purchase_time",
// "comparison": "less_than_x_days_ago",
// "value": 2
// }
// },
// {
// "push_subscription_status": {
// "comparison": "is",
// "value": "opted_in"
// }
// }
// ]
// },
// {
// "email_subscription_status": {
// "comparison": "is_not",
// "value": "subscribed"
// }
// },
// {
// "last_used_app": {
// "comparison": "after",
// "value": "2019-07-22T13:17:55+0000"
// }
// }
// ]
// },
// "campaign_id": "campaign_identifier",
// "send_id": "send_identifier",
// "override_frequency_capping": "false",
// "recipient_subscription_state": "all",
// "messages": {
// "android_push": "(optional, Android Push Object)",
// "apple_push": "(optional, Apple Push Object)",
// "content_card": "(optional, Content Card Object)",
// "email": "(optional, Email Object)",
// "kindle_push": "(optional, Kindle/FireOS Push Object)",
// "web_push": "(optional, Web Push Object)",
// "windows_phone8_push": "(optional, Windows Phone 8 Push Object)",
// "windows_universal_push": "(optional, Windows Universal Push Object)"
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "broadcast" "false" To iSuccess
Get ComUpdateString Of hoJson "external_user_ids" "external_user_identifiers" To iSuccess
Get ComUpdateString Of hoJson "user_aliases.alias_name" "example_name" To iSuccess
Get ComUpdateString Of hoJson "user_aliases.alias_label" "example_label" To iSuccess
Get ComUpdateString Of hoJson "segment_id" "segment_identifier" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[0].custom_attribute.custom_attribute_name" "eye_color" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[0].custom_attribute.comparison" "equals" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[0].custom_attribute.value" "blue" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[1].custom_attribute.custom_attribute_name" "favorite_foods" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[1].custom_attribute.comparison" "includes_value" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[1].custom_attribute.value" "pizza" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[2].OR[0].custom_attribute.custom_attribute_name" "last_purchase_time" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[2].OR[0].custom_attribute.comparison" "less_than_x_days_ago" To iSuccess
Get ComUpdateInt Of hoJson "audience.AND[2].OR[0].custom_attribute.value" 2 To iSuccess
Get ComUpdateString Of hoJson "audience.AND[2].OR[1].push_subscription_status.comparison" "is" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[2].OR[1].push_subscription_status.value" "opted_in" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[3].email_subscription_status.comparison" "is_not" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[3].email_subscription_status.value" "subscribed" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[4].last_used_app.comparison" "after" To iSuccess
Get ComUpdateString Of hoJson "audience.AND[4].last_used_app.value" "2019-07-22T13:17:55+0000" To iSuccess
Get ComUpdateString Of hoJson "campaign_id" "campaign_identifier" To iSuccess
Get ComUpdateString Of hoJson "send_id" "send_identifier" To iSuccess
Get ComUpdateString Of hoJson "override_frequency_capping" "false" To iSuccess
Get ComUpdateString Of hoJson "recipient_subscription_state" "all" To iSuccess
Get ComUpdateString Of hoJson "messages.android_push" "(optional, Android Push Object)" To iSuccess
Get ComUpdateString Of hoJson "messages.apple_push" "(optional, Apple Push Object)" To iSuccess
Get ComUpdateString Of hoJson "messages.content_card" "(optional, Content Card Object)" To iSuccess
Get ComUpdateString Of hoJson "messages.email" "(optional, Email Object)" To iSuccess
Get ComUpdateString Of hoJson "messages.kindle_push" "(optional, Kindle/FireOS Push Object)" To iSuccess
Get ComUpdateString Of hoJson "messages.web_push" "(optional, Web Push Object)" To iSuccess
Get ComUpdateString Of hoJson "messages.windows_phone8_push" "(optional, Windows Phone 8 Push Object)" To iSuccess
Get ComUpdateString Of hoJson "messages.windows_universal_push" "(optional, Windows Universal Push Object)" To iSuccess
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://rest.iad-01.braze.com/messages/send" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
Curl Command
curl -X POST
-d '{
"broadcast": "false",
"external_user_ids": "external_user_identifiers",
"user_aliases": {
"alias_name": "example_name",
"alias_label": "example_label"
},
"segment_id": "segment_identifier",
"audience": {
"AND": [
{
"custom_attribute": {
"custom_attribute_name": "eye_color",
"comparison": "equals",
"value": "blue"
}
},
{
"custom_attribute": {
"custom_attribute_name": "favorite_foods",
"comparison": "includes_value",
"value": "pizza"
}
},
{
"OR": [
{
"custom_attribute": {
"custom_attribute_name": "last_purchase_time",
"comparison": "less_than_x_days_ago",
"value": 2
}
},
{
"push_subscription_status": {
"comparison": "is",
"value": "opted_in"
}
}
]
},
{
"email_subscription_status": {
"comparison": "is_not",
"value": "subscribed"
}
},
{
"last_used_app": {
"comparison": "after",
"value": "2019-07-22T13:17:55+0000"
}
}
]
},
"campaign_id": "campaign_identifier",
"send_id": "send_identifier",
"override_frequency_capping": "false",
"recipient_subscription_state": "all",
"messages": {
"android_push": "(optional, Android Push Object)",
"apple_push": "(optional, Apple Push Object)",
"content_card": "(optional, Content Card Object)",
"email": "(optional, Email Object)",
"kindle_push": "(optional, Kindle/FireOS Push Object)",
"web_push": "(optional, Web Push Object)",
"windows_phone8_push": "(optional, Windows Phone 8 Push Object)",
"windows_universal_push": "(optional, Windows Universal Push Object)"
}
}\''
https://rest.iad-01.braze.com/messages/send
Postman Collection Item JSON
{
"name": "Sending Messages Immediately via API Only",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"broadcast\": \"false\",\n \"external_user_ids\": \"external_user_identifiers\",\n \"user_aliases\": {\n \"alias_name\": \"example_name\",\n \"alias_label\": \"example_label\"\n },\n \"segment_id\": \"segment_identifier\",\n \"audience\": {\n \"AND\": [\n {\n \"custom_attribute\": {\n \"custom_attribute_name\": \"eye_color\",\n \"comparison\": \"equals\",\n \"value\": \"blue\"\n }\n },\n {\n \"custom_attribute\": {\n \"custom_attribute_name\": \"favorite_foods\",\n \"comparison\": \"includes_value\",\n \"value\": \"pizza\"\n }\n },\n {\n \"OR\": [\n {\n \"custom_attribute\": {\n \"custom_attribute_name\": \"last_purchase_time\",\n \"comparison\": \"less_than_x_days_ago\",\n \"value\": 2\n }\n },\n {\n \"push_subscription_status\": {\n \"comparison\": \"is\",\n \"value\": \"opted_in\"\n }\n }\n ]\n },\n {\n \"email_subscription_status\": {\n \"comparison\": \"is_not\",\n \"value\": \"subscribed\"\n }\n },\n {\n \"last_used_app\": {\n \"comparison\": \"after\",\n \"value\": \"2019-07-22T13:17:55+0000\"\n }\n }\n ]\n },\n \"campaign_id\": \"campaign_identifier\",\n \"send_id\": \"send_identifier\",\n \"override_frequency_capping\": \"false\",\n \"recipient_subscription_state\": \"all\",\n \"messages\": {\n \"android_push\": \"(optional, Android Push Object)\",\n \"apple_push\": \"(optional, Apple Push Object)\",\n \"content_card\": \"(optional, Content Card Object)\",\n \"email\": \"(optional, Email Object)\",\n \"kindle_push\": \"(optional, Kindle/FireOS Push Object)\",\n \"web_push\": \"(optional, Web Push Object)\",\n \"windows_phone8_push\": \"(optional, Windows Phone 8 Push Object)\",\n \"windows_universal_push\": \"(optional, Windows Universal Push Object)\"\n }\n}'"
},
"url": {
"raw": "https://{{instance_url}}/messages/send",
"protocol": "https",
"host": [
"{{instance_url}}"
],
"path": [
"messages",
"send"
]
},
"description": "This endpoint allows you send your messages using our API. Be sure to include Messaging Objects in your body to complete your requests.\n\nThe 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 .\n\n### Request Parameters\n\n| Parameter | Required | Data Type | Description |\n| --------- | ---------| --------- | ----------- |\n|`broadcast`|Optional|Boolean|See broadcast -- defaults to false on 8/31/17, must be set to true if \"recipients\" is omitted|\n|`external_user_ids` | Optional | Array of strings | See external identifier |\n|`user_aliases`|Optional|Array of user alias objects| See user alias object|\n|`segment_id `| Optional | String | See segment identifier |\n|`audience`|Optional|Connected audience object|See connected audience|\n|`campaign_id`|Optional*|String| *Required if you wish to track campaign stats (e.g. sends, clicks, bounces, etc) on the Braze dashboard. <br>See campaign identifier for more information|\n|`send_id`| Optional | String | See send identifier |\n|`override_frequency_capping`|Optional|Boolean|Ignore frequency_capping for campaigns, defaults to false |\n|`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'|\n|`messages`| Optional | Messaging objects | See available messaging objects|\n\n### Request Components\n- [Broadcast](https://www.braze.com/docs/api/parameters/#broadcast)\n- [User Alias Object](https://www.braze.com/docs/api/objects_filters/user_alias_object/)\n- [Segment Identifier](https://www.braze.com/docs/api/identifier_types/)\n- [Connected Audience](https://www.braze.com/docs/api/objects_filters/connected_audience/)\n- [Campaign Identifier](https://www.braze.com/docs/api/identifier_types/)\n- [Recipients](https://www.braze.com/docs/api/objects_filters/recipient_object/)\n- [API Parameters](https://www.braze.com/docs/api/parameters)\n\n### Available Messaging Objects\n\n- [Android Objects](https://www.braze.com/docs/api/objects_filters/android_objects/)\n- [Apple Objects](https://www.braze.com/docs/api/objects_filters/apple_objects/)\n- [Content Cards Object](https://www.braze.com/docs/api/objects_filters/content_cards_object/)\n- [Email Object](https://www.braze.com/docs/api/objects_filters/email_object/)\n- [Kindle or FireOS Object](https://www.braze.com/docs/api/objects_filters/kindle_and_fireos_object/)\n- [SMS Object](https://www.braze.com/docs/api/objects_filters/sms_object/)\n- [Web Objects](https://www.braze.com/docs/api/objects_filters/web_objects/)\n- [Webhook Object](https://www.braze.com/docs/api/objects_filters/webhook_object/)\n- [Windows Objects](https://www.braze.com/docs/api/objects_filters/windows_objects/)\n\n\n## Response Details\n\nMessage 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]({{site.baseurl}}/help/help_articles/data/dispatch_id/)."
},
"response": [
]
}
