Chilkat Online Tools

Ruby / Braze Endpoints / User Profile Export by Global Control Group

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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"
# }

json = Chilkat::CkJsonObject.new()
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.put_AuthToken("{{api_key}}")

# resp is a CkHttpResponse
resp = http.PostJson3("https://rest.iad-01.braze.com/users/export/global_control_group","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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": [
  ]
}