Newsletter

Request

Fields when send to the api inside a request.

Field Type Description
shop_ids [Int] Send the newsletter to the customers of these shops
subject String Email subject
html String HTML from the email

Response

Fields when returned by the api in a response.

Field Type Description
shop_ids [Int] Send the newsletter to the customers of these shops
subject String Email subject
html String HTML from the email
id Int ID
recipient_count Int To how many people was the newsletter sent
sent_at DateTime When the newsletter was sent

Examples

Request

When used inside a request.

Example 1 

{
    "shop_ids": [
        15,
        17,
        16
    ],
    "subject": "...",
    "html": "..."
}

Response

When returned in a response.

Example 1 

{
    "shop_ids": [
        12,
        14,
        18
    ],
    "subject": "...",
    "html": "...",
    "id": 17,
    "recipient_count": 12,
    "sent_at": "2019-01-31 12:00:00"
}
1.9.0 stable