BokaMera.API.Host

<back to all web services

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.
UpdateNewsletterTemplate Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdpathintYesThe newsletter template id.
HeadingbodystringYesThe newsletter template heading.
BodybodystringYesThe newsletter template body.
ImageUrlbodystringYesThe newsletter template image url.
SendMethodIdbodyint?NoThe newsletter template send method (1=email, 2=sms).
EmailTemplateIdbodyint?NoThe email template id. Get valid email templates from GET /newsletter/emailtemplates
NewsletterTemplatesQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe newsletter template id
HeadingformstringYesThe newsletter template heading.
BodyformstringYesThe newsletter template body.
EmailTemplateIdformint?NoThe email template the newsletter uses.
SendMethodIdformintNoSend Method. 1 = Email, 2 = SMS
ImageUrlformstringYesThe newsletter template image url.
CreatedformDateTimeNoThe newsletter created date.
SendMethodInformationformNewsletterSendMethodQueryResponseYesSend method information.
EmailTemplateInformationformNewsletterEmailTemplatesQueryResponseYesEmail template information.
NewsletterSendMethodQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe send method id
NameformstringYesThe send method name.
DescriptionformstringYesThe send method description.
NewsletterEmailTemplatesQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe email template id
NameformstringYesThe email template name.
DescriptionformstringYesThe email template description.
BodyformstringYesThe email template html content.

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

HTTP + CSV

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: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Heading":"String","Body":"String","ImageUrl":"String","SendMethodId":0,"EmailTemplateId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}