<back to all web services


Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/newsletter/sendSend a newsletter to a customers.
SendNewsLetter Parameters:
NameParameterData TypeRequiredDescription
IdbodyintYesThe newsletter template id.
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
SendDatebodyDateTimeYesThe datetime when the newsletters should be sent.
CustomersbodyList<Guid>YesThe customer ids to send newsletters to.
SendNewslettersResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNoThe number of messages that are added into queue.
SendMethodIdformintNoSend Method. 1 = Email, 2 = SMS
MessageExampleformstringNoMessage example sent (in HTML format)

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


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

POST /newsletter/send HTTP/1.1 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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