사용자의 구독 그룹 상태 업데이트(V2)
post
/v2/subscription/status/set
이 엔드포인트를 사용하여 Braze 대시보드에서 최대 50명의 사용자 구독 상태를 일괄 업데이트할 수 있습니다.
구독 그룹페이지로 이동하여 구독 그룹의 subscription_group_id
에 액세스할 수 있습니다.
이메일 구독 그룹에 대한 이 엔드포인트의 예제를 보거나 테스트하려면 다음과 같이 하세요:
예제를 보거나 SMS 구독 그룹에 대한 이 엔드포인트를 테스트하려면 다음과 같이 하세요:
WhatsApp 그룹에 대한 이 엔드포인트의 예시를 보거나 테스트하려면 다음과 같이 하세요:
전제 조건
이 엔드포인트를 사용하려면 subscription.status.set
권한이 있는 API 키가 필요합니다.
사용량 제한
요청 본문
1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
4
5
6
7
8
9
10
11
{
"subscription_groups":[
{
"subscription_group_id": (required, string),
"subscription_state": (required, string)
"external_ids": (required*, array of strings),
"emails": (required*, array of strings),
"phones": (required*, array of strings in E.164 format),
}
]
}
emails
및phones
매개변수 둘 다 포함할 수는 없습니다. 또한,emails
,phones
,external_ids
모두 개별적으로 보낼 수 있습니다.
tip:
/users/track
엔드포인트를 통해 새 사용자를 만들 때 사용자 속성 개체 내에서 구독 그룹을 설정할 수 있습니다. 이를 통해 한 번의 API 호출로 사용자를 생성하고 구독 그룹 상태를 설정할 수 있습니다.
요청 매개변수
매개변수 | 필수 | 데이터 유형 | 설명 |
---|---|---|---|
subscription_group_id |
필수 | 문자열 | 구독 그룹의 id . |
subscription_state |
필수 | 문자열 | 사용 가능한 값은 unsubscribed (구독 그룹에 속하지 않음) 또는 subscribed (구독 그룹에 속함)입니다. |
external_ids |
필수* | 문자열 배열 | 사용자(또는 사용자)의 external_id 에는 최대 50개의 id 을 포함할 수 있습니다. |
emails |
필수* | 문자열 또는 문자열 배열 | 사용자의 이메일 주소는 문자열 배열로 전달할 수 있습니다. 이메일 주소를 하나 이상(최대 50개) 포함해야 합니다. 동일한 워크스페이스에서 여러 사용자( external_id )가 동일한 이메일 주소를 공유하는 경우 이메일 주소를 공유하는 모든 사용자에게 구독 그룹 변경 사항이 업데이트됩니다. |
phones |
필수* | 문자열의 E.164 형식 | 사용자의 전화번호는 문자열 배열로 전달할 수 있습니다. 전화번호를 하나 이상 포함해야 합니다(최대 50개까지 가능). |
note:
emails
및 phones
매개변수를 모두 포함할 수는 없습니다. 또한, emails
, phones
, external_ids
모두 개별적으로 보낼 수 있습니다.
요청 예시
다음 예제에서는 external_id
를 사용하여 이메일과 SMS에 대해 하나의 API 호출을 수행합니다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"subscription_groups":[
{
"subscription_group_id":"subscription_group_identifier",
"subscription_state":"subscribed",
"external_ids":["example-user","[email protected]"]
},
{
"subscription_group_id":"subscription_group_identifier",
"subscription_state":"subscribed",
"external_ids":["example-user","[email protected]"]
}
]
}
이메일
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"subscription_groups":[
{
"subscription_group_id":"subscription_group_identifier",
"subscription_state":"subscribed",
"emails":["[email protected]","[email protected]"]
}
]
}
'
SMS 및 WhatsApp
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"subscription_groups":[
{
"subscription_group_id":"subscription_group_identifier",
"subscription_state":"subscribed",
"phones":["+12223334444","+15556667777"]
}
]
}
'
New Stuff!