BokaMera.API.Host

<back to all web services

DeleteNewsletterTemplate

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/newsletter/templates/{Id}Delete a company newsletter template.Delete a company newsletter template.
DeleteNewsletterTemplate Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdpathintYesThe newsletter template id.
NewsletterTemplatesQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe newsletter template id
HeadingformstringNoThe newsletter template heading.
BodyformstringNoThe newsletter template body.
EmailTemplateIdformint?NoThe email template the newsletter uses.
SendMethodIdformintNoSend Method. 1 = Email, 2 = SMS
ImageUrlformstringNoThe newsletter template image url.
CreatedformDateTimeNoThe newsletter created date.
SendMethodInformationformNewsletterSendMethodQueryResponseNoSend method information.
EmailTemplateInformationformNewsletterEmailTemplatesQueryResponseNoEmail template information.
NewsletterSendMethodQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe send method id
NameformstringNoThe send method name.
DescriptionformstringNoThe send method description.
NewsletterEmailTemplatesQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe email template id
NameformstringNoThe email template name.
DescriptionformstringNoThe email template description.
BodyformstringNoThe email template html content.

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.

DELETE /newsletter/templates/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
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>