Chilkat Online Tools

DataFlex / Braze Endpoints / Identify Users

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

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

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

    // {
    //   "aliases_to_identify": [
    //     {
    //       "external_id": "external_identifier",
    //       "user_alias": {
    //         "alias_name": "example_alias",
    //         "alias_label": "example_label"
    //       }
    //     }
    //   ]
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "aliases_to_identify[0].external_id" "external_identifier" To iSuccess
    Get ComUpdateString Of hoJson "aliases_to_identify[0].user_alias.alias_name" "example_alias" To iSuccess
    Get ComUpdateString Of hoJson "aliases_to_identify[0].user_alias.alias_label" "example_label" To iSuccess

    Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
    // Adds the "Authorization: Bearer {{api_key}}" header.
    Set ComAuthToken Of hoHttp To "{{api_key}}"

    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://rest.iad-01.braze.com/users/identify" "application/json" vJson To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln iTemp1
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1
    Send Destroy of hoResp


End_Procedure

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{api_key}}"
	-d '{
  "aliases_to_identify" : 
  [
    {
      "external_id": "external_identifier",
      "user_alias" : {
          "alias_name" : "example_alias",
          "alias_label" : "example_label"
      }
    }
  ]
}'
https://rest.iad-01.braze.com/users/identify

Postman Collection Item JSON

{
  "name": "Identify Users",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{api_key}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"aliases_to_identify\" : \n  [\n    {\n      \"external_id\": \"external_identifier\",\n      \"user_alias\" : {\n          \"alias_name\" : \"example_alias\",\n          \"alias_label\" : \"example_label\"\n      }\n    }\n  ]\n}"
    },
    "url": {
      "raw": "https://{{instance_url}}/users/identify",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "users",
        "identify"
      ]
    },
    "description": "Use this endpoint to identify an unidentified (alias-only) user.\n\n> Identifying a user requires an `external_id` to be included in the aliases to identify the object. If the `external_id` is not a valid or known ID, it will simply be added to the aliases user's record, and the user will be considered identified.<br><br>Subsequently, you can associate multiple additional user aliases with a single `external_id`. When these subsequent associations are made, only the push tokens and message history associated with the user alias are retained; any attributes, events or purchases will be \"orphaned\" and not available on the identified user. One workaround is to export the aliased user's data before identification using the `/users/export/ids` endpoint, then re-associate the attributes, events, and purchases with the identified user.<br><br>You can add up to 50 user aliases per request.\n\n### Parameters\n| Parameter | Required | Data Type | Description |\n| -----------|----------| --------|------- |\n| `aliases_to_identify` | Yes | Array of aliases to identify object | See alias to identify object |\n\n### Request Components\n- [Alias to Identify Object](https://www.braze.com/docs/api/objects_filters/aliases_to_identify/)\n- [User Alias Object](https://www.braze.com/docs/api/objects_filters/user_alias_object/)\n<br><br>\n\n### Aliases to Identify Object Specification\n```json\n{\n  \"external_id\" : (required, string) see External User ID below,\n  // external_ids for users that do not exist will return a non-fatal error. \n  // See Server Responses for details.\n  \"user_alias\" : {\n    \"alias_name\" : (required, string),\n    \"alias_label\" : (required, string)\n  }\n}\n```"
  },
  "response": [
  ]
}