BokaMera.API.Host

SendNewsLetter

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/newsletter/send	Send a newsletter to a customers.

"use strict";
export class SendNewslettersResponse {
    /** @param {{Total?:number,SendMethodId?:number,MessageExample?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The number of messages that are added into queue. */
    Total;
    /**
     * @type {number}
     * @description Send Method. 1 = Email, 2 = SMS */
    SendMethodId;
    /**
     * @type {string}
     * @description Message example sent (in HTML format) */
    MessageExample;
}
export class SendNewsLetter {
    /** @param {{Id?:number,CompanyId?:string,SendDate?:string,Customers?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The newsletter template id. */
    Id;
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description The datetime when the newsletters should be sent. */
    SendDate;
    /**
     * @type {string[]}
     * @description The customer ids to send newsletters to. */
    Customers;
}

JavaScript SendNewsLetter DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /newsletter/send HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Id":0,"CompanyId":"00000000-0000-0000-0000-000000000000","Customers":["00000000-0000-0000-0000-000000000000"]}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Total":0,"SendMethodId":0,"MessageExample":"String"}