<back to all web services


Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/messages/templatesCreate a new company message templatesCreate a new company message templates.
CreateMessageTemplate Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
TypeIdbodyintYesThe message type id. See GET /messages/templates/types
NamebodystringYesThe message template name.
TitlebodystringYesThe message template title.
BodybodystringYesThe message template title.
SenderbodystringNoThe message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).
LanguagebodystringNoTemplate Language sv / en
Servicesbodyint[]NoThe services that is connected to the template. If null it will be connected to all services.
MessageTemplatesQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe message template id
NameformstringNoThe message template name.
TitleformstringNoThe message template title.
BodyformstringNoThe message template title.
SenderformstringNoThe 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.
MessageTypeformMessageTypeQueryResponseNoIf the message type information.
LanguageformstringNoTemplate language.
ServicesformList<MessageServices>NoThe 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
NameformstringNoThe message type name.
DescriptionformstringNoThe message type description.
MaxCharactersformintNoThe maximum number of charachters that can be entered into message body using this type.
DefaultTextformstringNoThe 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
NameformstringNoName of the service
ImageUrlformUriNoThe image url of the service

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


The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /messages/templates HTTP/1.1 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length