BokaMera.API.Host

<back to all web services

UpdateMessageTemplate

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/messages/templates/{Id}Updates an existing company message templatesUpdate an existing company message templates.
UpdateMessageTemplate Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdpathintYesThe message template id.
TypeIdbodyint?NoThe message type id. See GET /messages/templates/types
Defaultbodybool?NoThe message should be default and the one to be used. All other messages for the same message type will be set to Default = false
NamebodystringYesThe message template name.
TitlebodystringYesThe message template title.
BodybodystringYesThe message template title.
SenderbodystringYesThe message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).
LanguagebodystringYesMessage template lanugage
Servicesbodyint[]YesThe services that is connected to the template. If null it will be connected to all services.
MessageTemplatesQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe message template id
NameformstringYesThe message template name.
TitleformstringYesThe message template title.
BodyformstringYesThe message template title.
SenderformstringYesThe message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).
DefaultformboolNoIf the message template is the default message currently in use.
MessageTypeformMessageTypeQueryResponseYesIf the message type information.
LanguageformstringYesTemplate language.
ServicesformList<MessageServices>YesThe connected services which the template is valid for. If empty then it's valid for all services.
MessageTypeQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe message type id
NameformstringYesThe message type name.
DescriptionformstringYesThe message type description.
MaxCharactersformintNoThe maximum number of characters that can be entered into message body using this type.
DefaultTextformstringYesThe default text that is always included when sending messages of this type.
SendMethodIdformintNoThe send method for this type. 1 = Email, 2 = SMS.
MessageServices Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringYesName of the service
ImageUrlformUriYesThe image url of the service

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 /messages/templates/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Id: 0,
	TypeId: 0,
	Default: False,
	Name: String,
	Title: String,
	Body: String,
	Sender: String,
	Language: String,
	Services: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Name: String,
	Title: String,
	Body: String,
	Sender: String,
	Default: False,
	MessageType: 
	{
		Id: 0,
		Name: String,
		Description: String,
		MaxCharacters: 0,
		DefaultText: String,
		SendMethodId: 0
	},
	Language: String,
	Services: 
	[
		{
			Id: 0,
			Name: String
		}
	]
}