| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /newsletter/send | Send a newsletter to a customers. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class SendNewsLetter : ICompany
{
/**
* The newsletter template id.
*/
@ApiMember(Description="The newsletter template id.", IsRequired=true)
var Id:Int? = null
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
var CompanyId:UUID? = null
/**
* The datetime when the newsletters should be sent.
*/
@ApiMember(Description="The datetime when the newsletters should be sent.", IsRequired=true)
var SendDate:Date? = null
/**
* The customer ids to send newsletters to.
*/
@ApiMember(Description="The customer ids to send newsletters to.", IsRequired=true)
var Customers:ArrayList<UUID> = ArrayList<UUID>()
}
open class SendNewslettersResponse
{
/**
* The number of messages that are added into queue.
*/
@ApiMember(Description="The number of messages that are added into queue.")
var Total:Int? = null
/**
* Send Method. 1 = Email, 2 = SMS
*/
@ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
var SendMethodId:Int? = null
/**
* Message example sent (in HTML format)
*/
@ApiMember(Description="Message example sent (in HTML format)")
var MessageExample:String? = null
}
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 /newsletter/send HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
CompanyId: 00000000-0000-0000-0000-000000000000,
Customers:
[
00000000-0000-0000-0000-000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Total: 0,
SendMethodId: 0,
MessageExample: String
}