사용자 별칭 업데이트
post
/users/alias/update
이 엔드포인트를 사용하여 기존 사용자 별칭을 업데이트하세요.
요청당 최대 50개의 사용자 별칭을 지정할 수 있습니다.
사용자 별칭을 업데이트하려면 alias_label
, old_alias_name
, new_alias_name
가 업데이트 사용자 별칭 객체에 포함되어야 합니다. alias_label
및 old_alias_name
에 연결된 사용자 별칭이 없는 경우 별칭이 업데이트되지 않습니다. 주어진 alias_label
및 old_alias_name
이 발견되면 old_alias_name
이 new_alias_name
으로 업데이트됩니다.
note:
이 엔드포인트는 업데이트되는 alias_updates
객체의 순서를 보장하지 않습니다.
필수 구성 요소
이 엔드포인트를 사용하려면 users.alias.update
권한이 있는 API 키가 필요합니다.
사용량 제한
요청 본문
1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
1
2
3
{
"alias_updates" : (required, array of update user alias object)
}
요청 매개변수
매개변수 | 필수 | 데이터 유형 | 설명 |
---|---|---|---|
alias_updates |
필수 | 업데이트 사용자 별칭 객체 배열 | 사용자 별칭 개체를 참조하세요.old_alias_name , new_alias_name , alias_label 에 대한 자세한 내용은 사용자 별칭을 참조하세요. |
업데이트 사용자 별칭 객체 사양이 포함된 엔드포인트 요청 본문
1
2
3
4
5
{
"alias_label" : (required, string),
"old_alias_name" : (required, string),
"new_alias_name" : (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/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
"alias_updates" :[
{
"alias_label": "example_alias_label",
"old_alias_name" : "example_old_alias_name",
"new_alias_name" : "example_new_alias_name"
}
]
}'
New Stuff!