| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /newsletter/templates/{Id} | Update a company newsletter template. | Update a company newsletter template. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| Id | path | int | Yes | The newsletter template id. |
| Heading | body | string | Yes | The newsletter template heading. |
| Body | body | string | Yes | The newsletter template body. |
| ImageUrl | body | string | Yes | The newsletter template image url. |
| SendMethodId | body | int? | No | The newsletter template send method (1=email, 2=sms). |
| EmailTemplateId | body | int? | No | The email template id. Get valid email templates from GET /newsletter/emailtemplates |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The newsletter template id |
| Heading | form | string | Yes | The newsletter template heading. |
| Body | form | string | Yes | The newsletter template body. |
| EmailTemplateId | form | int? | No | The email template the newsletter uses. |
| SendMethodId | form | int | No | Send Method. 1 = Email, 2 = SMS |
| ImageUrl | form | string | Yes | The newsletter template image url. |
| Created | form | DateTime | No | The newsletter created date. |
| SendMethodInformation | form | NewsletterSendMethodQueryResponse | Yes | Send method information. |
| EmailTemplateInformation | form | NewsletterEmailTemplatesQueryResponse | Yes | Email template information. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The send method id |
| Name | form | string | Yes | The send method name. |
| Description | form | string | Yes | The send method description. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The email template id |
| Name | form | string | Yes | The email template name. |
| Description | form | string | Yes | The email template description. |
| Body | form | string | Yes | The email template html content. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>