<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/sendemailSend email to any email recipientSend email to any email recipient.
SendEmail Parameters:
NameParameterData TypeRequiredDescription
CompanyIdpathGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ReceiverbodystringNoThe message receiver email.
MessageTitlebodystringNoMessage Title.
MessageBodybodystringNoMessage Body.
ToSendDatebodyDateTimeNoWhen the message will be sent.
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 .csv suffix or ?format=csv


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

POST /messages/sendemail 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