GET subscribers/{id}/subscriptions/{name}

Overview

GET subscribers/{id}/subscriptions/{name} returns the specified division’s subscription state information and event history, for the specified subscriber.

Resource URI

GET https://api.yesmail.com/v2/subscribers/{id}/subscriptions/{name}

Call Description

The GET subscribers/{id}/subscriptions/{name} call returns the subscription state information and event history for a specified division for an existing specified customerDefinedID + Api-User.

HTTP Return Codes

Code

Description

200 OK

The request has succeeded.

401 Unauthorized

The request requires user authentication.  Invalid Api-User and/or Api-Key header value.

404 Not Found

The server has not found anything matching the request resource.   For instance, the “id” or subscription does not exist.

Response Payload: 
{
    "division": "Division1",
    "state": "subscribed",
    "events": [
        {
            "state": "subscribed",
            "time": "2013-01-01T08:09:10Z"
        },
        {
            "state": "unsubscribed",
            "time": "2013-01-12T14:15:16Z"
        },
        {
            "state": "subscribed",
            "time": "2013-02-01T12:13:14Z"
        }
    ]
}