Lists¶

GET /api/v1/lists¶

List of existing subscriber lists.

Response JSON Array of Objects:

id (int) – list’s unique identifier
create_datetime (datetime) – list’s creation datetime
create_user (int) – list’s creation user‘s unique identifier
update_datetime (datetime) – list’s last update datetime
update_user (int) – list’s last update user‘s unique identifier
name (string) – list’s name
default_from_name (string) – list’s future mailings’ default “from name”
default_from_email (email) – list’s future mailings’ default “from email”
default_replyto_email (email) – list’s the future mailings’ default “reply to email”
default_language (string) – list’s default language
languages (array) – list’s allowed languages

Request:

GET /api/v1/lists HTTP/1.1
Host: account.emailicious.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Allow: GET, HEAD, OPTIONS
Content-Type: application/json

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "create_datetime": "2014-01-09T13:51:11.516441Z",
            "create_user": 1,
            "update_datetime": "2014-01-09T13:51:11.516481Z",
            "update_user": 1,
            "name": "Default",
            "default_from_name": "Emailicious",
            "default_from_email": "noreply@emailicious.com",
            "default_replyto_email": "info@emailicious.com",
            "default_language": "en",
            "languages": [
                "en",
                "fr"
            ]
        }
    ]
}

POST /api/v1/lists¶

Create a new subscriber list.

Request JSON Object:
	name (string) – list’s name default_from_name (string) – list’s future mailings’ default “from name” default_from_email (email) – list’s future mailings’ default “from email” default_replyto_email (email) – list’s the future mailings’ default “reply to email” default_language (string) – list’s default language languages (array) – list’s allowed languages
Response JSON Object:
	id (int) – list’s unique identifier create_datetime (datetime) – list’s creation datetime create_user (int) – list’s creation user‘s unique identifier update_datetime (datetime) – list’s last update datetime update_user (int) – list’s last update user‘s unique identifier name (string) – list’s name default_from_name (string) – list’s future mailings’ default “from name” default_from_email (email) – list’s future mailings’ default “from email” default_replyto_email (email) – list’s the future mailings’ default “reply to email” default_language (string) – list’s default language languages (array) – list’s allowed languages
Status Codes:	201 Created – list created 400 Bad Request – invalid subscriber list data

Request:

POST /api/v1/lists HTTP/1.1
Host: account.emailicious.com
Accept: application/json
Content-Type: application/json

{
    "name": "Default",
    "default_from_name": "Emailicious",
    "default_from_email": "noreply@emailicious.com",
    "default_replyto_email": "info@emailicious.com",
    "default_language": "en",
    "languages": [
        "en",
        "fr"
    ]
}

Response:

HTTP/1.1 201 CREATED
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json

{
    "id": 1,
    "create_datetime": "2013-02-26T17:10:21.150Z",
    "create_user": 1,
    "update_datetime": "2013-02-26T17:10:21.150Z",
    "update_user": 1,
    "name": "Default",
    "default_from_name": "Emailicious",
    "default_from_email": "noreply@emailicious.com",
    "default_replyto_email": "info@emailicious.com",
    "default_language": "en",
    "languages": [
        "en",
        "fr"
    ]
}

GET /api/v1/lists/(int: id)¶

Details of the subscriber list matching the specified id.

Parameters:

id (int) – list’s unique identifier

Response JSON Object:

id (int) – list’s unique identifier
create_datetime (datetime) – list’s creation datetime
create_user (int) – list’s creation user‘s unique identifier
update_datetime (datetime) – list’s last update datetime
update_user (int) – list’s last update user‘s unique identifier
name (string) – list’s name
default_from_name (string) – list’s future mailings’ default “from name”
default_from_email (email) – list’s future mailings’ default “from email”
default_replyto_email (email) – list’s the future mailings’ default “reply to email”
default_language (string) – list’s default language
languages (array) – list’s allowed languages

Request:

GET /api/v1/lists/1 HTTP/1.1
Host: account.emailicious.com
Accept: application/json

Response:

HTTP/1.1 200 OK
Vary: Accept
Allow: GET, PUT, DELETE, HEAD, OPTIONS, PATCH
Content-Type: application/json

{
    "id": 1,
    "create_datetime": "2014-01-09T13:51:11.516441Z",
    "create_user": 1,
    "update_datetime": "2014-01-09T13:51:11.516481Z",
    "update_user": 1,
    "name": "Default",
    "default_from_name": "Emailicious",
    "default_from_email": "noreply@emailicious.com",
    "default_replyto_email": "info@emailicious.com",
    "default_language": "en",
    "languages": [
        "en",
        "fr"
    ]
}

Status Codes:	404 Not Found – no subscriber list match the specified `id`

PUT /api/v1/lists/(int: id)¶

Alter the subscriber list matching the specified id.

Request JSON Object:
Parameters:	id (int) – list’s unique identifier
	name (string) – list’s name default_from_name (string) – list’s future mailings’ default “from name” default_from_email (email) – list’s future mailings’ default “from email” default_replyto_email (email) – list’s the future mailings’ default “reply to email” default_language (string) – list’s default language languages (array) – list’s allowed languages
Response JSON Object:
	id (int) – list’s unique identifier create_datetime (datetime) – list’s creation datetime create_user (int) – list’s creation user‘s unique identifier update_datetime (datetime) – list’s last update datetime update_user (int) – list’s last update user‘s unique identifier name (string) – list’s name default_from_name (string) – list’s future mailings’ default “from name” default_from_email (email) – list’s future mailings’ default “from email” default_replyto_email (email) – list’s the future mailings’ default “reply to email” default_language (string) – list’s default language languages (array) – list’s allowed languages

Request:

PUT /api/v1/lists/1 HTTP/1.1
Host: account.emailicious.com
Accept: application/json
Content-Type: application/json

{
    "name": "Altered name",
    "default_from_name": "Emailicious",
    "default_from_email": "noreply@emailicious.com",
    "default_replyto_email": "info@emailicious.com",
    "default_language": "en",
    "languages": [
        "en",
    ]
}

Response:

HTTP/1.1 200 OK
Vary: Accept
Allow: GET, PUT, DELETE, HEAD, OPTIONS, PATCH
Content-Type: application/json

{
    "id": 1,
    "create_datetime": "2014-01-09T13:51:11.516441Z",
    "create_user": 1,
    "update_datetime": "2015-01-09T13:51:11.516481Z",
    "update_user": 1,
    "name": "Altered name",
    "default_from_name": "Emailicious",
    "default_from_email": "noreply@emailicious.com",
    "default_replyto_email": "info@emailicious.com",
    "default_language": "en",
    "languages": [
        "en",
    ]
}

Status Codes:	400 Bad Request – invalid subscriber list data 404 Not Found – no subscriber list match the specified `id`

PATCH /api/v1/lists/(int: id)¶

Partially alter the subscriber list matching the specified id.

Request JSON Object:
Parameters:	id (int) – list’s unique identifier
	name (string) – list’s name default_from_name (string) – list’s future mailings’ default “from name” default_from_email (email) – list’s future mailings’ default “from email” default_replyto_email (email) – list’s the future mailings’ default “reply to email” default_language (string) – list’s default language languages (array) – list’s allowed languages
Response JSON Object:
	id (int) – list’s unique identifier create_datetime (datetime) – list’s creation datetime create_user (int) – list’s creation user‘s unique identifier update_datetime (datetime) – list’s last update datetime update_user (int) – list’s last update user‘s unique identifier name (string) – list’s name default_from_name (string) – list’s future mailings’ default “from name” default_from_email (email) – list’s future mailings’ default “from email” default_replyto_email (email) – list’s the future mailings’ default “reply to email” default_language (string) – list’s default language languages (array) – list’s allowed languages

Request:

PATCH /api/v1/lists/1 HTTP/1.1
Host: account.emailicious.com
Accept: application/json
Content-Type: application/json

{
    "default_from_name": "From emailicious",
}

Response:

HTTP/1.1 200 OK
Vary: Accept
Allow: GET, PUT, DELETE, HEAD, OPTIONS, PATCH
Content-Type: application/json

{
    "id": 1,
    "create_datetime": "2014-01-09T13:51:11.516441Z",
    "create_user": 1,
    "update_datetime": "2015-01-09T13:51:11.516481Z",
    "update_user": 1,
    "name": "Default",
    "default_from_name": "From emailicious",
    "default_from_email": "noreply@emailicious.com",
    "default_replyto_email": "info@emailicious.com",
    "default_language": "en",
    "languages": [
        "en",
        "fr"
    ]
}

Status Codes:	400 Bad Request – invalid subscriber list data 404 Not Found – no subscriber list match the specified `id`

DELETE /api/v1/lists/(int: id)¶

Delete the subscriber list matching the specified id.

Parameters:	id (int) – list’s unique identifier

Warning

Deleting a subscriber list will also irreversibly delete all associated mailings and statistics.

Request:

DELETE /api/v1/lists/1 HTTP/1.1
Host: account.emailicious.com
Accept: application/json

Response:

HTTP/1.1 204 NO CONTENT
Vary: Accept
Allow: GET, PUT, DELETE, HEAD, OPTIONS, PATCH

Status Codes:	204 No Content – the subscriber list was deleted successfully 404 Not Found – no subscriber list match the specified `id`