Foxpro / Braze Endpoints / Sending Messages Immediately via API Only
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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)"
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("broadcast","false")
loJson.UpdateString("external_user_ids","external_user_identifiers")
loJson.UpdateString("user_aliases.alias_name","example_name")
loJson.UpdateString("user_aliases.alias_label","example_label")
loJson.UpdateString("segment_id","segment_identifier")
loJson.UpdateString("audience.AND[0].custom_attribute.custom_attribute_name","eye_color")
loJson.UpdateString("audience.AND[0].custom_attribute.comparison","equals")
loJson.UpdateString("audience.AND[0].custom_attribute.value","blue")
loJson.UpdateString("audience.AND[1].custom_attribute.custom_attribute_name","favorite_foods")
loJson.UpdateString("audience.AND[1].custom_attribute.comparison","includes_value")
loJson.UpdateString("audience.AND[1].custom_attribute.value","pizza")
loJson.UpdateString("audience.AND[2].OR[0].custom_attribute.custom_attribute_name","last_purchase_time")
loJson.UpdateString("audience.AND[2].OR[0].custom_attribute.comparison","less_than_x_days_ago")
loJson.UpdateInt("audience.AND[2].OR[0].custom_attribute.value",2)
loJson.UpdateString("audience.AND[2].OR[1].push_subscription_status.comparison","is")
loJson.UpdateString("audience.AND[2].OR[1].push_subscription_status.value","opted_in")
loJson.UpdateString("audience.AND[3].email_subscription_status.comparison","is_not")
loJson.UpdateString("audience.AND[3].email_subscription_status.value","subscribed")
loJson.UpdateString("audience.AND[4].last_used_app.comparison","after")
loJson.UpdateString("audience.AND[4].last_used_app.value","2019-07-22T13:17:55+0000")
loJson.UpdateString("campaign_id","campaign_identifier")
loJson.UpdateString("send_id","send_identifier")
loJson.UpdateString("override_frequency_capping","false")
loJson.UpdateString("recipient_subscription_state","all")
loJson.UpdateString("messages.android_push","(optional, Android Push Object)")
loJson.UpdateString("messages.apple_push","(optional, Apple Push Object)")
loJson.UpdateString("messages.content_card","(optional, Content Card Object)")
loJson.UpdateString("messages.email","(optional, Email Object)")
loJson.UpdateString("messages.kindle_push","(optional, Kindle/FireOS Push Object)")
loJson.UpdateString("messages.web_push","(optional, Web Push Object)")
loJson.UpdateString("messages.windows_phone8_push","(optional, Windows Phone 8 Push Object)")
loJson.UpdateString("messages.windows_universal_push","(optional, Windows Universal Push Object)")
loResp = loHttp.PostJson3("https://rest.iad-01.braze.com/messages/send","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp
RELEASE loHttp
RELEASE loJson
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": [
]
}
