Listes

GET /api/v1/lists

Liste des listes d’abonnés existantes.

Response JSON Array of Objects:  

• id (int) – l’identifiant unique de la liste
• create_datetime (datetime) – le datetime de création de la liste
• create_user (int) – l’identifiant unique du créateur de la liste
• update_datetime (datetime) – le datetime de dernière modification de la liste
• update_user (int) – l’identifiant unique de l’utilisateur ayant fait la dernière modification à a liste
• name (string) – le nom de la liste
• default_from_name (string) – le nom d’expéditeur par défaut des envois futurs à cette liste
• default_from_email (email) – l’adresse d’expédition par défaut des envois futurs à cette liste
• default_replyto_email (email) – l’adresse de retour par défaut des envois futurs à cette liste
• default_language (string) – la langue par défaut de la liste
• languages (array) – les langues permise par la liste

Requête:

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

Réponse:

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

Crée une nouvelle liste d’abonnés.

Request JSON Object:  

• name (string) – le nom de la liste
• default_from_name (string) – le nom d’expéditeur par défaut des envois futurs à cette liste
• default_from_email (email) – l’adresse d’expédition par défaut des envois futurs à cette liste
• default_replyto_email (email) – l’adresse de retour par défaut des envois futurs à cette liste
• default_language (string) – la langue par défaut de la liste
• languages (array) – les langues permise par la liste

Response JSON Object:  

• id (int) – l’identifiant unique de la liste
• create_datetime (datetime) – le datetime de création de la liste
• create_user (int) – l’identifiant unique du créateur de la liste
• update_datetime (datetime) – le datetime de dernière modification de la liste
• update_user (int) – l’identifiant unique de l’utilisateur ayant fait la dernière modification à a liste
• name (string) – le nom de la liste
• default_from_name (string) – le nom d’expéditeur par défaut des envois futurs à cette liste
• default_from_email (email) – l’adresse d’expédition par défaut des envois futurs à cette liste
• default_replyto_email (email) – l’adresse de retour par défaut des envois futurs à cette liste
• default_language (string) – la langue par défaut de la liste
• languages (array) – les langues permise par la liste

Status Codes:

• 201 Created – liste crée
• 400 Bad Request – données de liste d’abonnés invalides

Requête:

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"
    ]
}

Réponse:

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)

Détails de la liste d’abonnés correspondant au id spécifié.

Parameters:

• id (int) – l’identifiant unique de la liste

Response JSON Object:  

• id (int) – l’identifiant unique de la liste
• create_datetime (datetime) – le datetime de création de la liste
• create_user (int) – l’identifiant unique du créateur de la liste
• update_datetime (datetime) – le datetime de dernière modification de la liste
• update_user (int) – l’identifiant unique de l’utilisateur ayant fait la dernière modification à a liste
• name (string) – le nom de la liste
• default_from_name (string) – le nom d’expéditeur par défaut des envois futurs à cette liste
• default_from_email (email) – l’adresse d’expédition par défaut des envois futurs à cette liste
• default_replyto_email (email) – l’adresse de retour par défaut des envois futurs à cette liste
• default_language (string) – la langue par défaut de la liste
• languages (array) – les langues permise par la liste

Requête:

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

Réponse:

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 – aucune liste d’abonnés ne correspond au id spécifié

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

Modification de la liste d’abonnés correspondant au id spécifié.

Parameters:

• id (int) – l’identifiant unique de la liste

Request JSON Object:  

• name (string) – le nom de la liste
• default_from_name (string) – le nom d’expéditeur par défaut des envois futurs à cette liste
• default_from_email (email) – l’adresse d’expédition par défaut des envois futurs à cette liste
• default_replyto_email (email) – l’adresse de retour par défaut des envois futurs à cette liste
• default_language (string) – la langue par défaut de la liste
• languages (array) – les langues permise par la liste

Response JSON Object:  

• id (int) – l’identifiant unique de la liste
• create_datetime (datetime) – le datetime de création de la liste
• create_user (int) – l’identifiant unique du créateur de la liste
• update_datetime (datetime) – le datetime de dernière modification de la liste
• update_user (int) – l’identifiant unique de l’utilisateur ayant fait la dernière modification à a liste
• name (string) – le nom de la liste
• default_from_name (string) – le nom d’expéditeur par défaut des envois futurs à cette liste
• default_from_email (email) – l’adresse d’expédition par défaut des envois futurs à cette liste
• default_replyto_email (email) – l’adresse de retour par défaut des envois futurs à cette liste
• default_language (string) – la langue par défaut de la liste
• languages (array) – les langues permise par la liste

Requête:

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",
    ]
}

Réponse:

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 – données de liste d’abonnés invalides
• 404 Not Found – aucune liste d’abonnés ne correspond au id spécifié

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

Modification partielle de la liste d’abonnés correspondant au id spécifié.

Parameters:

• id (int) – l’identifiant unique de la liste

Request JSON Object:  

• name (string) – le nom de la liste
• default_from_name (string) – le nom d’expéditeur par défaut des envois futurs à cette liste
• default_from_email (email) – l’adresse d’expédition par défaut des envois futurs à cette liste
• default_replyto_email (email) – l’adresse de retour par défaut des envois futurs à cette liste
• default_language (string) – la langue par défaut de la liste
• languages (array) – les langues permise par la liste

Response JSON Object:  

• id (int) – l’identifiant unique de la liste
• create_datetime (datetime) – le datetime de création de la liste
• create_user (int) – l’identifiant unique du créateur de la liste
• update_datetime (datetime) – le datetime de dernière modification de la liste
• update_user (int) – l’identifiant unique de l’utilisateur ayant fait la dernière modification à a liste
• name (string) – le nom de la liste
• default_from_name (string) – le nom d’expéditeur par défaut des envois futurs à cette liste
• default_from_email (email) – l’adresse d’expédition par défaut des envois futurs à cette liste
• default_replyto_email (email) – l’adresse de retour par défaut des envois futurs à cette liste
• default_language (string) – la langue par défaut de la liste
• languages (array) – les langues permise par la liste

Requête:

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

{
    "default_from_name": "From emailicious",
}

Réponse:

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 – données de liste d’abonnés invalides
• 404 Not Found – aucune liste d’abonnés ne correspond au id spécifié

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

Suppression de la liste d’abonnés correspondant au id spécifié.

Parameters:

• id (int) – l’identifiant unique de la liste

Avertissement

La suppression d’une liste entraînera inévitablement la suppression irréversible des envois et statistiques associés.

Requête:

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

Réponse:

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

Status Codes:

• 204 No Content – la liste d’abonnés à été supprimée avec succés
• 404 Not Found – aucune liste d’abonnés ne correspond au id spécifié