BokaMera.API.Host

<back to all web services

SendGetStartedMessage

The following routes are available for this service:
PUT/messages/getstartedWill send get started messages to all new customers that haven't get started yet
"use strict";
export class SendGetStartedMessageResponse {
    /** @param {{Companies?:number,SentCount?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Companies;
    /** @type {number} */
    SentCount;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SendGetStartedMessage {
    constructor(init) { Object.assign(this, init) }
}

JavaScript SendGetStartedMessage 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.

PUT /messages/getstarted HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Companies":0,"SentCount":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}