Skip to content

사용자의 구독 그룹 상태 업데이트

post

/subscription/status/set

core endpoint

이 엔드포인트를 사용하여 Braze 대시보드에서 최대 50명의 사용자 구독 상태를 일괄 업데이트할 수 있습니다.

구독 그룹 페이지로 이동하여 구독 그룹 subscription_group_id에 액세스할 수 있습니다.

이메일 구독 그룹에 대한 이 엔드포인트의 예제를 보거나 테스트하려면 다음과 같이 하세요:

See me in Postman

예제를 보거나 SMS 구독 그룹에 대한 이 엔드포인트를 테스트하려면 다음과 같이 하세요:

See me in Postman

필수 구성 요소

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

사용량 제한

요청 본문

1
2

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6
7

{
   "subscription_group_id": (required, string) the id of your subscription group,
   "subscription_state": (required, string) available values are "unsubscribed" (not in subscription group) or "subscribed" (in subscription group),
   "external_id": (required*, array of strings) the external ID of the user or users, may include up to 50 IDs,
   "phone": (required*, array of strings in E.164 format) The phone number of the user (must include at least one phone number and at most 50 phone numbers),
   // SMS subscription group - one of external_id or phone is required
 }

* SMS 구독 그룹: external_id 또는 phone만 허용됩니다.

1
2

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6
7
8

{
   "subscription_group_id": (required, string) the id of your subscription group,
   "subscription_state": (required, string) available values are "unsubscribed" (not in subscription group) or "subscribed" (in subscription group),
   "external_id": (required*, array of strings) the external ID of the user or users, may include up to 50 IDs,
   "email": (required*, array of strings) the email address of the user (must include at least one email and at most 50 emails),
   // Email subscription group - one of external_id or email is required
   // Note that sending an email address that is linked to multiple profiles will update all relevant profiles
 }

* 이메일 구독 그룹: email 또는 external_id 중 하나가 필요합니다.

이 속성은 사용자의 프로필 정보를 업데이트하는 데 사용해서는 안 됩니다. 대신 /users/track 속성을 사용하세요.

요청 매개변수

요청 예시

이메일

1
2
3
4
5
6
7
8
9
10

curl --location --request POST 'https://rest.iad-01.braze.com/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_group_id": "subscription_group_identifier",
  "subscription_state": "unsubscribed",
  "external_id": "external_identifier",
  "email": ["example1@email.com", "example2@email.com"]
}
'

SMS

1
2
3
4
5
6
7
8
9
10

curl --location --request POST 'https://rest.iad-01.braze.com/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "subscription_group_id": "subscription_group_identifier",
  "subscription_state": "unsubscribed",
  "external_id": "external_identifier",
  "phone": ["+12223334444", "+11112223333"]
}
'

성공 응답의 예

201 상태 코드는 다음과 같은 응답 본문을 반환할 수 있습니다.

1
2
3

{
    "message": "success"
}
Github   GitHub 에서 이 페이지를 편집합니다.
이 페이지가 얼마나 도움이 되었나요?
New Stuff!