PUT subscribers/{id}/subscriptions/{name}

Overview

PUT /v2/subscribers/{id}/subscriptions/{name} sets the specified division subscription status to "subscribed" for the specified subscriber.

There is no request payload for this API call.

Resource URI

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

Call Description

The PUT /v2/subscribers/{id}/subscriptions/{name} call sets the subscription status to "subscribed" 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” does not exist.

409 Conflict

This occurs when the If-Match condition is used, and the specified ETag does not match the current ETag for the resource.
   
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"
        }
    ]
}