| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /newsletter/send | Send a newsletter to a customers. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendNewslettersResponse:
# @ApiMember(Description="The number of messages that are added into queue.")
total: int = 0
"""
The number of messages that are added into queue.
"""
# @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
send_method_id: int = 0
"""
Send Method. 1 = Email, 2 = SMS
"""
# @ApiMember(Description="Message example sent (in HTML format)")
message_example: Optional[str] = None
"""
Message example sent (in HTML format)
"""
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendNewsLetter(ICompany):
# @ApiMember(Description="The newsletter template id.", IsRequired=true)
id: int = 0
"""
The newsletter template id.
"""
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(Description="The datetime when the newsletters should be sent.", IsRequired=true)
send_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The datetime when the newsletters should be sent.
"""
# @ApiMember(Description="The customer ids to send newsletters to.", IsRequired=true)
customers: Optional[List[str]] = None
"""
The customer ids to send newsletters to.
"""
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
}