<back to all web services


Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
POST/messages/templates/testTest to send a message to a Email or Mobile phone recepient using SMS.
TestSendMessageTemplate 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.
TitlebodystringNoThe message template title.
BodybodystringYesThe newsletter template body.
TypeIdbodyint?YesThe message type id. See GET /messages/templates/types
LanguagebodystringYesMessage template lanugage
Servicesbodyint[]NoThe services that is connected to the message. If null it will be connected to all services.
MessageLogQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe message log id
BookingIdformint?NoThe booking id for the message (if connected to a booking).
ReceiverformstringNoThe message receiver. Either a email or a mobile phone number.
MessageTitleformstringNoMessage Title.
StorageUrlformstringNoMessage Storage Url.
MessageBodyformstringNoMessage 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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback


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

POST /messages/templates/test HTTP/1.1 
Accept: application/json
Content-Type: application/json
Content-Length: length

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length