Get single subscription
Returns a specific subscription by ID.
Please log in to see full path URL. Learn why.
get
/subscriptions/1/subscription/{channel}/{subscriptionId}
Authorizations:
Scopes:
path Parameters
subscriptionId required | string ID of the subscription you want to get. |
channel required | string Enum: "BLOCKLIST" "CUSTOMER_ENGAGEMENT" "EMAIL" "FACEBOOK" "KAKAO_ALIM" "KAKAO_CHINGU" "LINE" "MMS" "MOBILE_IDENTITY" "MOBILE_PUSH" "NUMBER_LOOKUP" "OPEN_CHANNEL" "RCS" "REGISTRATION" "SMS" "VIBER" "VOICE_VIDEO" "WHATSAPP" "ZALO" Channel name. A separate subscription is needed for each channel. |
Responses
200
Success.
400
Bad request.
401
Unauthorized
403
Forbidden
404
Not found.
429
Too many requests.
500
Internal Server Error
Request samples
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Example
cURL
Copy
curl -L -g 'https://{baseUrl}/subscriptions/1/subscription/{channel}/{subscriptionId}' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json'
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
- 500
Content type
application/json
Example
Response example
Copy
Collapse all {- "subscriptionId": "ABC-123-DEF",
- "name": "Default group",
- "profile": {
- "profileId": "NOTIF-32395",
- "security": {
- "authId": "NEWAUTH-9291"
}
}, - "events": [
- "DELIVERY"
], - "criteria": [
- {
- "applicationId": "production",
- "entityId": "entity1"
}, - {
- "applicationId": "production",
- "entityId": "entity2"
}, - {
- "applicationId": "test",
- "entityId": "entity1"
}
], - "resources": [
- "1234"
], - "users": [
- "user1",
- "user2"
]
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See