BokaMera.API.Host

<back to all web services

UpdateSystemSetting

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/settings/systemUpdate system settings for the currently logged in userUpdate system settings for the currently logged in user.
UpdateSystemSetting Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ActivebodyboolNoIf the booking is active or not
InactiveMessagebodystringNoIf the booking is not active, what message to show to the customers
SearchablebodyboolNoIf the company should be visible in search results on hompage
GATrackingIdbodystringNoIf you have a google analytics account and want to track your customers behaviors.
GoogleAdsConversionIdbodystringNoIf you have a google Ads Conversion Id account and want to track your customers behaviors.
LinkedinTagIdbodystringNoIf you have a LinkedIn account and want to track your customers behaviors.
GoogleAdsConversionLabelbodystringNoIf you have a Google Ads Conversion Label and want to track your customers behaviors.
FacebookPixelIdbodystringNoIf you have a facebook account and want to track your customers behaviors.
ShowOnMarketplacebodyboolNoIf the company should be visible on the marketplace
MultiLanguagebodyboolNoIf you want your customers to be albe to change language on your homepage
EnableAPITranslationbodyboolNoIf you want your own written text on your homepage to be translated using google analytics when a user changes language
DefaultLanguagebodystringNoWhat is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN
SystemSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
LanguageOptionsformList<LanguageResponse>NoThe country options to choose from
ActiveformboolNoIf the booking is active or not
InactiveMessageformstringNoIf the booking is not active, what message to show to the customers
SearchableformboolNoIf the company should be visible in search results on hompage
GATrackingIdformstringNoIf you have a google analytics account and want to track your customers behaviors.
GoogleAdsConversionIdformstringNoIf you have a google Ads Conversion Id account and want to track your customers behaviors.
LinkedinTagIdformstringNoIf you have a LinkedIn account and want to track your customers behaviors.
GoogleAdsConversionLabelformstringNoIf you have a Google Ads Conversion Label and want to track your customers behaviors.
FacebookPixelIdformstringNoIf you have a facebook account and want to track your customers behaviors.
ShowOnMarketplaceformboolNoIf the company should be visible on the marketplace
MultiLanguageformboolNoIf you want your customers to be albe to change language on your homepage
EnableAPITranslationformboolNoIf you want your own written text on your homepage to be translated using google analytics when a user changes language
DefaultLanguageformstringNoWhat is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN
LanguageResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo

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.

PUT /settings/system HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Active":false,"InactiveMessage":"String","Searchable":false,"GATrackingId":"String","GoogleAdsConversionId":"String","LinkedinTagId":"String","GoogleAdsConversionLabel":"String","FacebookPixelId":"String","ShowOnMarketplace":false,"MultiLanguage":false,"EnableAPITranslation":false,"DefaultLanguage":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"LanguageOptions":[{"Id":"String","Name":"String"}],"Active":false,"InactiveMessage":"String","Searchable":false,"GATrackingId":"String","GoogleAdsConversionId":"String","LinkedinTagId":"String","GoogleAdsConversionLabel":"String","FacebookPixelId":"String","ShowOnMarketplace":false,"MultiLanguage":false,"EnableAPITranslation":false,"DefaultLanguage":"String"}