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
InactiveMessagebodystringYesIf the booking is not active, what message to show to the customers
SearchablebodyboolNoIf the company should be visible in search results on homepage
GATrackingIdbodystringYesIf you have a Google Analytics account and want to track your customers behaviors.
GoogleAdsConversionIdbodystringYesIf you have a Google Ads Conversion Id account and want to track your customers behaviors.
LinkedinTagIdbodystringYesIf you have a LinkedIn account and want to track your customers behaviors.
GoogleAdsConversionLabelbodystringYesIf you have a Google Ads Conversion Label and want to track your customers behaviors.
GTMTrackingIdbodystringYesIf you have a Google Tag Manager account and want to track your customers behaviors.
FacebookPixelIdbodystringYesIf 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 able to change language on your homepage
EnableAPITranslationbodyboolNoIf you want your own written text on your homepage to be translated using Google Translate when a user changes language
DefaultLanguagebodystringYesWhat is the standard language your homepage information is written in. Select from the different countries, i.e. SE,NO,EN
SendCustomerInformationToExternalProvidersbodybool?NoIf you want to allow to send customer information in the tracking events to the external providers. Note you as a company are responsible for informing your customers and handling the data in terms of GDPR.
SMSMessageDailySendLimitbodyint?NoThe maximum number of SMS messages that can be sent per day.
EmailMessageDailySendLimitbodyint?NoThe maximum number of email messages that can be sent per day.
SystemSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
LanguageOptionsformList<LanguageResponse>YesThe country options to choose from
ActiveformboolNoIf the booking is active or not
InactiveMessageformstringYesIf the booking is not active, what message to show to the customers
SearchableformboolNoIf the company should be visible in search results on homepage
GATrackingIdformstringYesIf you have a Google Analytics account and want to track your customers behaviors.
GoogleAdsConversionIdformstringYesIf you have a Google Ads Conversion Id account and want to track your customers behaviors.
LinkedinTagIdformstringYesIf you have a LinkedIn account and want to track your customers behaviors.
GoogleAdsConversionLabelformstringYesIf you have a Google Ads Conversion Label and want to track your customers behaviors.
GTMTrackingIdformstringYesIf you have a Google Tag Manager account and want to track your customers behaviors.
FacebookPixelIdformstringYesIf 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 able to change language on your homepage
EnableAPITranslationformboolNoIf you want your own written text on your homepage to be translated using Google Translate when a user changes language
DefaultLanguageformstringYesWhat is the standard language your homepage information is written in. Select from the different countries, i.e. SE,NO,EN
SendCustomerInformationToExternalProvidersformboolNoIf you want to allow to send customer information in the tracking events to the external providers. Note you as a company are responsible for informing your customers and handling the data in terms of GDPR.
LanguageResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
NameformstringYes

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Active: False,
	InactiveMessage: String,
	Searchable: False,
	GATrackingId: String,
	GoogleAdsConversionId: String,
	LinkedinTagId: String,
	GoogleAdsConversionLabel: String,
	GTMTrackingId: String,
	FacebookPixelId: String,
	ShowOnMarketplace: False,
	MultiLanguage: False,
	EnableAPITranslation: False,
	DefaultLanguage: String,
	SendCustomerInformationToExternalProviders: False,
	SMSMessageDailySendLimit: 0,
	EmailMessageDailySendLimit: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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