Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"callback_endpoint","")
    CkJsonObject::ckUpdateString(json,"fields_to_export[0]","email")
    CkJsonObject::ckUpdateString(json,"fields_to_export[1]","braze_id")
    CkJsonObject::ckUpdateString(json,"output_format","zip")

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    ; Adds the "Authorization: Bearer {{api_key}}" header.
    CkHttp::setCkAuthToken(http, "{{api_key}}")

    resp.i = CkHttp::ckPostJson3(http,"https://rest.iad-01.braze.com/users/export/global_control_group","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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