Send newsletter email preview

POST /company/companies/@id/newsletters/send/preview

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
id Int The ID of the company

Body

Pass the following properties via application/json or form encoding in the body of the request.

A dictionary with fields

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
preview Dictionary A dictionary with fields
shop_ids [Int] Optional. Send the newsletter to the customers of these shops
subject String Optional. Email subject
html String Optional. HTML from the email

Example request 1 

POST /company/companies/10/newsletters/send/preview HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 167

{
    "shop_ids": [
        13,
        10,
        10
    ],
    "subject": "...",
    "html": "...",
    "preview": {
        "send_to": "example@domain.com"
    }
}

Response

Example response 1 

HTTP/1.1 200 OK
This is a development version Do not use this version in production
1.10.0 development