Getting Subscriber Information

GET /webhook/subscriber/info

Request Headers

Header	Description
X-Auth-Account-Url (required)	The base URL of the account, e.g. https://myaccount.ispringlearn.com
X-Auth-Email (required)	The login of Account Owner and Account Administrator.
X-Auth-Password (required)	The password of Account Owner and Account Administrator.

Sample Request

curl --location 'https://api-learn.ispringlearn.com/webhook/subscriber/info?subscriberName=subscriberName' \
--header 'X-Auth-Account-Url: https://myaccount.ispringlearn.com' \
--header 'X-Auth-Email: email@email.com' \
--header 'X-Auth-Password: password' \
--header 'Accept: application/json'

CODE

Response Parameters

Parameter

Description

subscriberStatus (required)

The status of a subscriber: active / inactive

confirmationStatus

The URL status: confirmed / unconfirmed.

notificationProcessStatus

The status of the message sending process:

Active — events are being sent.
Inactive — events are not sent.
Suspended — the event delivery failed, so the send is pending a retry. While waiting, events will accumulate and will not be lost. If the user's service becomes available, it will receive all the accumulated messages, and the sending status will become active again.

Sample Response

{
    "subscriberStatus": "ACTIVE",
    "confirmationStatus": "CONFIRMED",
    "notificationProcessStatus": "ACTIVE"
}

XML

Response Codes

Code	Text	Description
200	ОК	The response to the request has been received.
400	Bad Request	A request error.
401	Unauthorized	An authorization error.
403	Permission Denied	The user doesn't have enough permissions.
404	Subscriber not found	The subscriber was not found.