새 사용자 별칭 만들기

이 엔드포인트를 사용하여 식별된 기존 사용자에 대한 새 사용자 별칭을 추가하거나 식별되지 않은 새 사용자를 만들 수 있습니다.

요청당 최대 50개의 사용자 별칭을 지정할 수 있습니다.

기존 사용자에 대한 사용자 별칭을 추가하려면 새 사용자 별칭 개체에 external_id를 포함해야 합니다. 객체에 external_id가 있지만 해당 external_id가 있는 사용자가 없는 경우 별칭은 사용자에게 추가되지 않습니다. external_id가 없는 경우 사용자는 계속 생성되지만 나중에 식별해야 합니다. “사용자 식별” 및 users/identify 엔드포인트를 사용하여 이 작업을 수행할 수 있습니다.

새 별칭 전용 사용자를 만들려면 새 사용자 별칭 개체에서 external_id를 생략해야 합니다. 사용자가 생성된 후 /users/track 엔드포인트를 사용하여 별칭 전용 사용자를 속성, 이벤트 및 구매와 연결하고 /users/identify 엔드포인트를 사용하여 external_id가 있는 사용자를 식별합니다.

필수 구성 요소

이 엔드포인트를 사용하려면 users.alias.new 권한이 있는 API 키가 필요합니다.

사용량 제한

요청 본문

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
{
  "user_aliases" : (required, array of new user alias object)
}

요청 매개변수

새로운 사용자 별칭 객체 사양이 포함된 엔드포인트 요청 본문

1
2
3
4
5
{
  "external_id" : (optional, string),
  "alias_name" : (required, string),
  "alias_label" : (required, string)
}

예시 요청

1
2
3
4
5
6
7
8
9
10
11
12
curl --location --request POST 'https://rest.iad-01.braze.com/users/alias/new' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "user_aliases" :[
    {
      "external_id": "external_identifier",
      "alias_name" : "example_name",
      "alias_label" : "example_label"
    }
  ]
}'

응답

1
2
3
4
5
6
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
    "aliases_processed": 1,
    "message": "success"
}