GET /platform/v1/ens-subscriptions/{subscriptionId}

Overview 

Retrieves details for a subscription.

URL Parameters 

NameTypeDescription
subscriptionIdstringRequiredUnique identifier for the subscription.

Usage 

Example Request 

1Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
2GET /platform/v1/ens-subscriptions/d89c87c4-70f8-43d6-be1e-f01dce97fe4c
3Content-Type: application/json
4Authorization: Bearer YOUR_ACCESS_TOKEN

Example Response 

1HTTP/1.1 200 Success
2{
3    "callbackId": "65b885ab-c2b4-46fe-85d0-d6cb8be8057d",
4    "callbackName": "cb1",
5    "url": "https://example.com/",
6    "maxBatchSize": 1000,
7    "subscriptionName": "subscriptionName",
8    "eventCategoryTypes": ["TransactionalSendEvents.EmailNotSent",
9    "TransactionalSendEvents.EmailSent"],
10    "subscriptionId": "d89c87c4-70f8-43d6-be1e-f01dce97fe4c",
11    "filters": ["definitionKey=12345"],
12    "status": "active",
13    "statusReason": "none"
14}

HTTP Responses 

ResponseReason
200 SuccessCallback subscription is retrieved.
400 Bad RequestInvalid request
403 ForbiddenFailed to pass authorization.
404 Not FoundSubscription ID doesn’t exist.
500 Server ErrorInternal error

See Also