Chilkat Online Tools

Node.js / Braze Endpoints / Create Send IDs For Message Send Tracking

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();
    var success;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "campaign_id": "campaign_identifier",
    //   "send_id": "send_identifier"
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("campaign_id","campaign_identifier");
    json.UpdateString("send_id","send_identifier");

    http.SetRequestHeader("Content-Type","application/json");
    // Adds the "Authorization: Bearer {{api_key}}" header.
    http.AuthToken = "{{api_key}}";

    // resp: HttpResponse
    var resp = http.PostJson3("https://rest.iad-01.braze.com/sends/id/create","application/json",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{api_key}}"
	-d '{
"campaign_id": "campaign_identifier",
"send_id": "send_identifier"
}'
https://rest.iad-01.braze.com/sends/id/create

Postman Collection Item JSON

{
  "name": "Create Send IDs For Message Send Tracking",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{api_key}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\"campaign_id\": \"campaign_identifier\",\n\"send_id\": \"send_identifier\"\n}"
    },
    "url": {
      "raw": "https://{{instance_url}}/sends/id/create",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "sends",
        "id",
        "create"
      ]
    },
    "description": "Braze’s Send Identifier adds the ability to send messages and track message performance entirely programmatically, without campaign creation for each send. Using the Send Identifier to track and send messages is useful if you are planning to programmatically generate and send content.\n\nThe daily maximum number of custom send identifiers that can be created via this endpoint for a given app group is 100. Each send id - campaign id combination that you create will count towards your daily limit. The response headers for any valid request include the current rate limit status. \n\n### Request Parameters\n| Parameter | Required | Data Type | Description |\n| --------- | ---------| --------- | ----------- |\n|`campaign_id`|Required|String|See campaign identifier|\n|`send_id`| Optional | String | See send identifier |\n\n## Request Components\n- [Campaign Identifier](https://www.braze.com/docs/api/identifier_types/)\n\n\n## Response\n\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR-REST-API-KEY\n{\n  \"message\": \"success\",\n  \"send_id\" : \"example_send_id\"\n}\n```"
  },
  "response": [
  ]
}