<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/templates/testTest to send a newsletter to a Email or Mobile phone recepient using SMS.
TestSendNewsLetter Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ReceiverbodystringYesThe email recepient to receive the newsletter. For templates with send method SMS you need to enter a valid mobile phone number and send method Email a valid Email must be provided.
IdbodyintYesThe newsletter template id.
NewsletterLogQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe message log id
ReceiverformstringNoThe message receiver. Either a email or a mobile phone number.
MessageTitleformstringNoNessage Title.
MessageBodyformstringNoNessage Body.
CreatedformDateTimeNoWhen message was created.
ToSendDateformDateTimeNoWhen the message will be sent.
SentDateformDateTime?NoWhen the message was sent.
SentformboolNoIf Message is sent
MessageRetriesformintNoNumber of retries to send the message
SendMethodIdformintNoSend Method. 1 = Email, 2 = SMS

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


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

POST /newsletter/templates/test HTTP/1.1 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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