Get all Subscriptions
Use this endpoint to retrieve all active Subscriptions within your Responsys account. A successful response returns a list of all active subscriptions, the associated callback url, callback name, batch size, subscription status, and subscription event types.
Service URL:
/rest/api/v1.3/notifications/subscriptions
Request Method:
GET
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
Not applicable
Sample Request Body
Not applicable
Sample Response Body - Success
[
{
"subscriptionName": "<subscription_name>",
"callBackUrl": ""<callback_url>",
"callBackName": "<callback_name>",
"batchSize": 200,
"eventTypes": [
"EMAIL_SKIPPED"
],
"status": "ACTIVE",
"filters": [
{
"eventTypes": [
"EMAIL_FAILED"
],
"values": [
{
"campaignNames": [
"vk_campaign_failed"
]
}
]
},
{
"eventTypes": [
"EMAIL_SKIPPED"
],
"values": [
{
"campaignNames": [
"vk_campaign_skip"
]
}
]
}
],
"links": [
{
"rel": "self",
"href": "/rest/api/v1.3/notifications/subscriptions",
"method": "GET"
},
{
"rel": "createSubscription",
"href": "/rest/api/v1.3/notifications/subscriptions",
"method": "POST"
},
{
"rel": "deleteSubscription",
"href": "/rest/api/v1.3/notifications/subscriptions/<subscription_name>",
"method": "DELETE"
},
{
"rel": "updateSubscription",
"href": "/rest/api/v1.3/notifications/subscriptions/<subscription_name>",
"method": "PUT"
},
{
"rel": "getSubscription",
"href": "/rest/api/v1.3/notifications/subscriptions/<subscription_name>",
"method": "GET"
}
]
},
{
"subscriptionName": "<subscription_name>",
"callBackUrl": "<callback_url>",
"callBackName": "<callback_name>",
"batchSize": 200,
"eventTypes": [
"SMS_MO_FW_FAILED"
],
"status": "ACTIVE",
"links": [
{
"rel": "self",
"href": "/rest/api/v1.3/notifications/subscriptions",
"method": "GET"
},
{
"rel": "createSubscription",
"href": "/rest/api/v1.3/notifications/subscriptions",
"method": "POST"
},
{
"rel": "deleteSubscription",
"href": "/rest/api/v1.3/notifications/subscriptions/<subscription_name>",
"method": "DELETE"
},
{
"rel": "updateSubscription",
"href": "/rest/api/v1.3/notifications/subscriptions/<subscription_name>",
"method": "PUT"
},
{
"rel": "getSubscription",
"href": "/rest/api/v1.3/notifications/subscriptions/<subscription_name>",
"method": "GET"
}
]
}
]
Sample Response Body - Failure
404 Not Found
No Subscriptions: Requests fail if no subscriptions are found within the account. The error resembles:
{
"type": "",
"title": "No Subscriptions found in this account",
"errorCode": "NO_SUBSCRIPTION_FOUND",
"detail": "No subscription found in this account",
"errorDetails": []
}