Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
POST | /newsletter/send | Send a newsletter to a customers. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | body | int | Yes | The newsletter template id. |
CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
SendDate | body | DateTime | Yes | The datetime when the newsletters should be sent. |
Customers | body | List<Guid> | Yes | The customer ids to send newsletters to. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Total | form | int | No | The number of messages that are added into queue. |
SendMethodId | form | int | No | Send Method. 1 = Email, 2 = SMS |
MessageExample | form | string | No | Message example sent (in HTML format) |
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: api.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 }