GET subscribers/{id}

Overview

The subscriber profile is where personalization and targeting information is stored. GET /v2/subscribers/{id} returns the profile information, subscriptions, and email summary for a specified single subscriber. The id value can be a single value, e.g. email, or a composite value. When a composite id is used the values are ordered alphabetically and separated by a '|'.

Resource URI

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

Call Description

The GET /v2/subscribers/{id} call returns the profile information, subscriptions, and email summary for a specified single subscriber.

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” does not exist.

Response Payload: 
{
    "id": "jsmith@zzz.com",
    "lastUpdate": "2012-09-26T14:00:00Z",
    "email": "jsmith@zzz.com",
    "profile": {
            "userAttrs": [
            {"firstName": "John"},
            {"lastName": "Smith"},
            …more Users Table attributes…
        ]
    },
    "subscriptions": {
    "referred" = true or "dead" = true would go here, if applicable
        "memberOf": [
            "Division1",
            "Division2"
        ],
        "current": [
            {
                "division": "Division1",
                "state": "subscribed",
                "time": "2013-01-01T08:09:10Z"
            },
            {
                "division": "Division2",
                "state": "subscribed",
                "time": "2013-01-04T08:09:10Z"
            },
            {
                "division": "Division3",
                "state": "unsubscribed",
                "time": "2013-01-10T08:09:10Z"
            }
        ]
    }
}