Chilkat Online Tools

Node.js / Braze Endpoints / User Profile Export by Global Control Group

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.

    // {
    //   "callback_endpoint": "",
    //   "fields_to_export": [
    //     "email",
    //     "braze_id"
    //   ],
    //   "output_format": "zip"
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("callback_endpoint","");
    json.UpdateString("fields_to_export[0]","email");
    json.UpdateString("fields_to_export[1]","braze_id");
    json.UpdateString("output_format","zip");

    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/users/export/global_control_group","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 '{
    "callback_endpoint" : "",
    "fields_to_export" : ["email", "braze_id"],
    "output_format" : "zip"
}'
https://rest.iad-01.braze.com/users/export/global_control_group

Postman Collection Item JSON

{
  "name": "User Profile Export by Global Control Group",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{api_key}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"callback_endpoint\" : \"\",\n    \"fields_to_export\" : [\"email\", \"braze_id\"],\n    \"output_format\" : \"zip\"\n}"
    },
    "url": {
      "raw": "https://{{instance_url}}/users/export/global_control_group",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "users",
        "export",
        "global_control_group"
      ]
    }
  },
  "response": [
  ]
}