Chilkat Online Tools

PureBasic / Braze Endpoints / User Delete

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.

    ; {
    ;   "external_ids": [
    ;     "external_identifier1",
    ;     "external_identifier2"
    ;   ],
    ;   "user_aliases": [
    ;     "user_alias1",
    ;     "user_alias2"
    ;   ],
    ;   "braze_ids": [
    ;     "braze_identifier1",
    ;     "braze_identifier2"
    ;   ]
    ; }

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

    CkJsonObject::ckUpdateString(json,"external_ids[0]","external_identifier1")
    CkJsonObject::ckUpdateString(json,"external_ids[1]","external_identifier2")
    CkJsonObject::ckUpdateString(json,"user_aliases[0]","user_alias1")
    CkJsonObject::ckUpdateString(json,"user_aliases[1]","user_alias2")
    CkJsonObject::ckUpdateString(json,"braze_ids[0]","braze_identifier1")
    CkJsonObject::ckUpdateString(json,"braze_ids[1]","braze_identifier2")

    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/delete","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 '{
  "external_ids": ["external_identifier1", "external_identifier2"],
  "user_aliases": ["user_alias1", "user_alias2"],
  "braze_ids": ["braze_identifier1", "braze_identifier2"]
}'
https://rest.iad-01.braze.com/users/delete

Postman Collection Item JSON

{
  "name": "User Delete",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{api_key}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"external_ids\": [\"external_identifier1\", \"external_identifier2\"],\n  \"user_aliases\": [\"user_alias1\", \"user_alias2\"],\n  \"braze_ids\": [\"braze_identifier1\", \"braze_identifier2\"]\n}"
    },
    "url": {
      "raw": "https://{{instance_url}}/users/delete",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "users",
        "delete"
      ]
    },
    "description": "This endpoint allows you to delete any user profile by specifying a known user identifier. Up to 50 `external_ids`, `user_aliases`, or `braze_ids` can be included in a single request. Only one of `external_ids`, `user_aliases`, or `braze_ids` can be included in a single request.\n\n> Deleting user profiles CANNOT be undone. It will PERMANENTLY remove users which may cause discrepancies in your data. Learn more about [what happens when you delete a user profile via API](https://braze.com/docs/help/help_articles/api/delete_user/) in our Help documentation.\n\n### Request Parameter\n| Parameter | Required | Data Type | Description |\n| --------- | ---------| --------- | ----------- |\n| `external_ids` | Optional | Array of strings | External identifiers for the users to delete |\n| `user_aliases` | Optional | Array of user alias oblect | User aliases for the users to delete |\n| `braze_ids` | Optional | Array of strings | Braze user identifiers for the users to delete |\n\n### Request Components\n- [User Alias Object](https://www.braze.com/docs/api/objects_filters/user_alias_object/)"
  },
  "response": [
  ]
}