Auto-responder mails

The mails attached to auto-responders. You can list, retrieve and edit auto-responder mails.

---

Renders: [application/json, text/html, application/xml]

Parsers: [application/json, application/x-www-form-urlencoded, multipart/form-data]

---

Readonly fields

• id
• url
• blockdocument
• plain_text
• type
• updated
• created
• preview_url

Example auto-responder mail

{
    "id": 3,
    "url": "https://api.getanewsletter.com/v3/mails/responders/3/",
    "subject": "Example auto-responder.",
    "body": "<b>Lorem ipsum dolor sit amet.<b>",
    "blockdocument": null,
    "plain_text": "Lorem ipsum dolor sit amet.",
    "css": "",
    "type": 1,
    "updated": "2014-06-02T12:35:56Z",
    "created": "2014-06-02T12:35:56Z",
    "preview_url": "https://api.getanewsletter.com/v3/mails/all/3/preview/"
}

---

GET /mails/responders/

Responds with a list of auto-responder emails, like usual we provide next, prev, count and the results

Possible url parameters are:

• page: <int>

Example:

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://api.getanewsletter.com/v3/mails/responders/596/",
            "id": 596,
            "subject": "Example auto-responder 2.",
            "type": 1,
            "updated": "2014-06-24T11:14:07Z",
            "created": "2014-06-24T11:03:14Z",
            "preview_url": "https://api.getanewsletter.com/v3/mails/all/596/preview/"
        },
        {
            "url": "https://api.getanewsletter.com/v3/mails/responders/550/",
            "id": 550,
            "subject": "Example auto-responder.",
            "type": 1,
            "updated": "2014-06-02T12:35:56Z",
            "created": "2014-06-02T12:35:56Z",
            "preview_url": "https://api.getanewsletter.com/v3/mails/all/550/preview/"
        }
    ]
}

---

GET /mails/responders/<id>/

The details view includes the following additional fields: body, plain_text and css.

Note: Please have in mind that we do not support the creation and editing of block emails via the API, yet. The body and plain_text fields for block emails will be filled with null until the block editor is made available via the API. This means you can still use the block editor from the website to create the email and then send it from the API.

Example:

{
    "id": 3,
    "url": "https://api.getanewsletter.com/v3/mails/responders/3/",
    "subject": "Example auto-responder.",
    "body": "<b>Lorem ipsum dolor sit amet.<b>",
    "blockdocument": null,
    "plain_text": "Lorem ipsum dolor sit amet.",
    "css": "",
    "type": 1,
    "updated": "2014-06-02T12:35:56Z",
    "created": "2014-06-02T12:35:56Z",
    "preview_url": "https://api.getanewsletter.com/v3/mails/all/3/preview/"
}

---

PUT /mails/responders/<id>

Update an auto-responder mail. Will return status code 200 on successful execution.

Note: Only the emails of paused auto-responders can be edited.

Example:

PUT /mails/responders/597/
{
    "subject": "New subject",
    "body": "<p>New content</p>",
    "css": "body {\n    color: black;\n}"
}

Response
{
    "id": 597,
    "url": "https://api.getanewsletter.com/v3/mails/responders/597/",
    "subject": "New subject",
    "body": "<p>New content</p>",
    "blockdocument": null,
    "plain_text": "",
    "css": "body {\n    color: black;\n}",
    "type": 0,
    "updated": "2014-06-24T11:38:17.115Z",
    "created": "2014-06-24T11:23:13Z",
    "preview_url": "https://api.getanewsletter.com/v3/mails/all/597/preview/"
}
200 Updated

---

PATCH /mails/responders/<id>

Makes a partial update. Use it when you don't want to overwrite all values.

Note: Only the emails of paused auto-responders can be edited.

Example:

PUT /mails/responders/597/
{
    "subject": "Updated subject.",
}

Response
{
    "id": 597,
    "url": "https://api.getanewsletter.com/v3/mails/responders/597/",
    "subject": "Updated subject",
    "body": "<p>New content</p>",
    "blockdocument": null,
    "plain_text": "",
    "css": "body {\n    color: black;\n}",
    "type": 0,
    "updated": "2014-06-24T11:38:17.115Z",
    "created": "2014-06-24T11:23:13Z",
    "preview_url": "https://api.getanewsletter.com/v3/mails/all/597/preview/"
}
200 Updated