BokaMera.API.Host

<back to all web services

SubscribeToNewsletter

The following routes are available for this service:
PUT/newsletter/subscribeSubscribed to newsletter
SubscribeToNewsletter Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
SubscribedCompaniesbodyList<SubscribedUserResponse>YesCompanies for which user is subscribed.
SubscribedUserResponse Parameters:
NameParameterData TypeRequiredDescription
SubscribedformboolNo
CompanyIdformGuidNo

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

{"CompanyId":"00000000-0000-0000-0000-000000000000","SubscribedCompanies":[{"Subscribed":false}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"Subscribed":false}]