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

DELETE /newsletter/templates/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Id":0,"Heading":"String","Body":"String","EmailTemplateId":0,"SendMethodId":0,"ImageUrl":"String","SendMethodInformation":{"Id":0,"Name":"String","Description":"String"},"EmailTemplateInformation":{"Id":0,"Name":"String","Description":"String","Body":"String"}}