Create a list

Creates a new subscribers list.

POST https://go.smartrmail.com/api/v1/lists

Expected request

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

{
  "title": "Newsletter"
}

Expected response

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

{
  "id": "asdf"
  "name": "Newsletter",
  "subscribers_count": 0
}

Show all lists

Returns a list of all your subscriber lists

GET https://go.smartrmail.com/api/v1/lists

Expected response

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

[
  {
    "id": "asdf",
    "name": "Newsletter",
    "subscribers_count": 1000
  },
  {
    "id": "qwerty",
    "name": "Beta",
    "subscribers_count": 100
  }
]

Show a list

Returns the attributes of the requested list.

GET https://go.smartrmail.com/api/v1/lists/:list_id

Parameters

:list_id The ID of the requested list.

Expected response

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

{
  "id": "asdf",
  "name": "Newsletter",
  "subscribers_count": 1000
}

Update a list

Updates attributes of the requested list.

PUT https://go.smartrmail.com/api/v1/lists/:list_id

Parameters

:list_id The ID of the requested list.

Expected request

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

{
  "title": "Old Newsletter"
}

Expected response

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

{
  "id": "asdf",
  "name": "Old Newsletter",
  "subscribers_count": 1000
}

Delete a list

Deletes the requested list.

DELETE https://go.smartrmail.com/api/v1/lists/:list_id

Parameters

:list_id The ID of the requested list.

Expected response

HTTP/1.1 200 OK
Did this answer your question?