Show a subscriber

Returns the attributes of the requested subscriber.

GET https://go.smartrmail.com/api/v1/subscribers/:subscriber_email

Parameters

:subscriber_email The email address of the requested subscriber.

Expected response

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8

{
  "id": "asdf",
  "email": "vanhalen@example.com",
  "first_name": "van",
  "last_name": "halen",
  "status": "Subscribed",
  "unsubscribed_at": null,
  "complained": false,
  "delivered_count": 100,
  "opened_count": 100,
  "clicked_count": 100,
  "joined_at": "2013-03-11 01:00:00 UTC",
  "subscribed": true,
}

Update a subscriber

Updates attributes of the requested subscriber.

PUT https://go.smartrmail.com/api/v1/subscribers/:subscriber_email

Parameters

:subscriber_email The email address of the requested list subscriber.

Expected request

Accept: application/json
Authorization: token YOUR_API_TOKEN
Content-Type: application/json

{
  "email": "foo@example.com",
  "first_name": "john",
  "last_name": "bar",
  "subscribed": true
}

Expected response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "asdf",
  "email": "foo@bar",
  "first_name": "john",
  "last_name": "bar",
  "status": "Subscribed",
  "unsubscribed_at": null,
  "complained": false,
  "delivered_count": 100,
  "opened_count": 100,
  "clicked_count": 100,
  "joined_at": "2013-03-11 01:00:00 UTC",
  "subscribed": true,
}

Unsubscribe a subscriber

To unsubscribe a subscriber, submit a request to update the subscriber with a subscribed attribute value of false.

PUT https://go.smartrmail.com/api/v1/subscribers/:subscriber_email

Parameters

:subscriber_email The email address of the requested list subscriber.

Expected request

Accept: application/json
Authorization: token YOUR_API_TOKEN
Content-Type: application/json

{
  "subscribed": false
}
Did this answer your question?