Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
POST | /messages/sendemail | Send email to any email recipient | Send email to any email recipient. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | path | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
Receiver | body | string | No | The message receiver email. |
MessageTitle | body | string | No | Message Title. |
MessageBody | body | string | No | Message Body. |
ToSendDate | body | DateTime | No | When the message will be sent. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The message log id |
BookingId | form | int? | No | The booking id for the message (if connected to a booking). |
Receiver | form | string | No | The message receiver. Either a email or a mobile phone number. |
MessageTitle | form | string | No | Message Title. |
StorageUrl | form | string | No | Message Storage Url. |
MessageBody | form | string | No | Message Body. |
Created | form | DateTime | No | When message was created. |
ToSendDate | form | DateTime | No | When the message will be sent. |
SentDate | form | DateTime? | No | When the message was sent. |
Sent | form | bool | No | If Message is sent |
MessageRetries | form | int | No | Number of retries to send the message |
SendMethodId | form | int | No | Send Method. 1 = Email, 2 = SMS |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /messages/sendemail HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Receiver: String,
MessageTitle: String,
MessageBody: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Id: 0, BookingId: 0, Receiver: String, MessageTitle: String, StorageUrl: String, MessageBody: String, SentDate: "0001-01-01T00:00:00", Sent: False, MessageRetries: 0, SendMethodId: 0 }