BokaMera.API.Host

<back to all web services

SendNewsLetter

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/newsletter/sendSend a newsletter to a customers.
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class SendNewsLetter : ICompany, Codable
{
    /**
    * The newsletter template id.
    */
    // @ApiMember(Description="The newsletter template id.", IsRequired=true)
    public var id:Int

    /**
    * 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.")
    public var companyId:String?

    /**
    * The datetime when the newsletters should be sent.
    */
    // @ApiMember(Description="The datetime when the newsletters should be sent.", IsRequired=true)
    public var sendDate:Date

    /**
    * The customer ids to send newsletters to.
    */
    // @ApiMember(Description="The customer ids to send newsletters to.", IsRequired=true)
    public var customers:[String] = []

    required public init(){}
}

public class SendNewslettersResponse : Codable
{
    /**
    * The number of messages that are added into queue.
    */
    // @ApiMember(Description="The number of messages that are added into queue.")
    public var total:Int

    /**
    * Send Method. 1 = Email, 2 = SMS
    */
    // @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
    public var sendMethodId:Int

    /**
    * Message example sent (in HTML format)
    */
    // @ApiMember(Description="Message example sent (in HTML format)")
    public var messageExample:String

    required public init(){}
}


Swift SendNewsLetter DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length

{"Total":0,"SendMethodId":0,"MessageExample":"String"}