BokaMera.API.Host

UpdateNewsletterTemplate

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
PUT	/newsletter/templates/{Id}	Update a company newsletter template.	Update a company newsletter template.

"use strict";
export class NewsletterSendMethodQueryResponse {
    /** @param {{Id?:number,Name?:string,Description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The send method id */
    Id;
    /**
     * @type {string}
     * @description The send method name. */
    Name;
    /**
     * @type {string}
     * @description The send method description. */
    Description;
}
export class NewsletterEmailTemplatesQueryResponse {
    /** @param {{Id?:number,Name?:string,Description?:string,Body?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The email template id */
    Id;
    /**
     * @type {string}
     * @description The email template name. */
    Name;
    /**
     * @type {string}
     * @description The email template description. */
    Description;
    /**
     * @type {string}
     * @description The email template html content. */
    Body;
}
export class NewsletterTemplatesQueryResponse {
    /** @param {{Id?:number,Heading?:string,Body?:string,EmailTemplateId?:number,SendMethodId?:number,ImageUrl?:string,Created?:string,SendMethodInformation?:NewsletterSendMethodQueryResponse,EmailTemplateInformation?:NewsletterEmailTemplatesQueryResponse}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The newsletter template id */
    Id;
    /**
     * @type {string}
     * @description The newsletter template heading. */
    Heading;
    /**
     * @type {string}
     * @description The newsletter template body. */
    Body;
    /**
     * @type {?number}
     * @description The email template the newsletter uses. */
    EmailTemplateId;
    /**
     * @type {number}
     * @description Send Method. 1 = Email, 2 = SMS */
    SendMethodId;
    /**
     * @type {string}
     * @description The newsletter template image url. */
    ImageUrl;
    /**
     * @type {string}
     * @description The newsletter created date. */
    Created;
    /**
     * @type {NewsletterSendMethodQueryResponse}
     * @description Send method information. */
    SendMethodInformation;
    /**
     * @type {NewsletterEmailTemplatesQueryResponse}
     * @description Email template information. */
    EmailTemplateInformation;
}
export class UpdateNewsletterTemplate {
    /** @param {{CompanyId?:string,Id?:number,Heading?:string,Body?:string,ImageUrl?:string,SendMethodId?:number,EmailTemplateId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {number}
     * @description The newsletter template id. */
    Id;
    /**
     * @type {string}
     * @description The newsletter template heading. */
    Heading;
    /**
     * @type {string}
     * @description The newsletter template body. */
    Body;
    /**
     * @type {string}
     * @description The newsletter template image url. */
    ImageUrl;
    /**
     * @type {?number}
     * @description The newsletter template send method (1=email, 2=sms). */
    SendMethodId;
    /**
     * @type {?number}
     * @description The email template id. Get valid email templates from GET /newsletter/emailtemplates */
    EmailTemplateId;
}

JavaScript UpdateNewsletterTemplate DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /newsletter/templates/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateNewsletterTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Body>String</Body>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <EmailTemplateId>0</EmailTemplateId>
  <Heading>String</Heading>
  <Id>0</Id>
  <ImageUrl>String</ImageUrl>
  <SendMethodId>0</SendMethodId>
</UpdateNewsletterTemplate>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NewsletterTemplatesQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Body>String</Body>
  <Created>0001-01-01T00:00:00</Created>
  <EmailTemplateId>0</EmailTemplateId>
  <EmailTemplateInformation>
    <Body>String</Body>
    <Description>String</Description>
    <Id>0</Id>
    <Name>String</Name>
  </EmailTemplateInformation>
  <Heading>String</Heading>
  <Id>0</Id>
  <ImageUrl>String</ImageUrl>
  <SendMethodId>0</SendMethodId>
  <SendMethodInformation>
    <Description>String</Description>
    <Id>0</Id>
    <Name>String</Name>
  </SendMethodInformation>
</NewsletterTemplatesQueryResponse>